Appearance
Detail Protocol API
API Information
- Request Path:
/metadata/detail/protoc - Request Method:
GET - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
Request Parameters
| Parameter | Type | Required | Description | Constraints |
|---|---|---|---|---|
| metadataId | Long | Yes | Metadata ID | Must be a valid metadata ID |
Parameter Example
/metadata/detail/protoc?metadataId=12345Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | DetailProtocResp | Protocol details response |
DetailProtocResp Object
| Field | Type | Description |
|---|---|---|
| content | List<DetailReleaseData> | List of published protocols |
DetailReleaseData Object (Nested in DetailProtocResp)
| Field | Type | Description |
|---|---|---|
| protocId | Integer | Protocol ID, 1-WMS, 2-WMTS, 3-XYZ, Only 2-WMTS is available at present. |
| protocName | String | Protocol Name |
| publishStatus | String | Publish status, 0-unpublished, 1-publishing, 2-published, 3-publish failed, 4-waiting published |
| taskId | String | Task Id |
Response Examples
Success Response
json
{
"code": 200,
"message": "OK",
"data": {
"content": [
{
"protocId": 2,
"protocName": "WMTS",
"publishStatus": 2,
"taskId": "1991684738578407424"
},
{
"protocId": 1,
"protocName": "WMS",
"publishStatus": 0,
"taskId": ""
},
{
"protocId": 3,
"protocName": "XYZ",
"publishStatus": 0,
"taskId": ""
}
]
}
}Failure Response
json
{
"code": 404,
"message": "Metadata not found",
"data": null
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 404 | Metadata not found |
| 500 | Server internal error |
Usage Instructions
- This API is used to query protocol publishing details for a specific metadata
- User authentication is required
- Metadata ID must be provided as query parameter
- Returns detailed information about published protocols including endpoints and statistics
Notes
- Metadata ID is required and must be a valid metadata ID
- Returns information about all protocols that the metadata is published with
- Includes access statistics and publishing status
- User authentication token must be included in request headers