Appearance
Detail Protocol API
API Information
- Request Path:
/metadata/query/detail - 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/query/detail?metadataId=12345Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | MetaDataDetailResp | Metadata details response |
MetaDataDetailResp Object
| Field | Type | Description |
|---|---|---|
| id | Long | Metadata id |
| name | String | Metadata name |
| dataFileId | Long | Data file id |
| datasetId | Long | Dateset id |
| datasetName | String | Dateset name |
| tagInfos | List<MetaDataTagInfoVo> | Tag Info List |
| publishStatus | Long | publish status, 0-unpublished, 1-publishing, 2-published, 3-publish failed, 4-waiting published |
| publishResult | Tile | Metadata name |
MetaDataTagInfoVo Object (Nested in MetaDataDetailResp)
| Field | Type | Description |
|---|---|---|
| tagId | Long | Tag ID |
| tagName | String | Tag Name |
Tile Object (Nested in MetaDataDetailResp)
| Field | Type | Description |
|---|---|---|
| id | String | Tile ID |
| url | String | Service URL |
| previewUrl | String | Preview URL |
| protoc | Integer | Protocol type |
| bbox | List<Double> | Bounding box coordinates [minX, minY, maxX, maxY] |
| minZoom | Integer | Minimum zoom level |
| maxZoom | Integer | Maximum zoom level |
| baseUrl | String | Base URL |
| layerName | String | Layer name |
| metadataName | String | Metadata name |
| geoThumbnailPath | String | Geographic thumbnail path |
Response Examples
Success Response
json
{
"code": 200,
"message": "OK",
"data": {
"id": 408,
"name": "API_TEST_LOCAL_METADATA",
"dataFileId": 776,
"datasetId": 67,
"datasetName": "TEST_DATASET",
"tagInfos": [
{
"metaDataId": 408,
"tagId": 18,
"tagName": "TEST_TAG"
}
],
"publishStatus": 2,
"publishResult": {
"id": "1992846896224792576",
"url": "",
"previewUrl": "https://eo.origen.ae/domSliceResult/mosaicjson/preview?url=https://eo.origen.ae/gis_platform/eo-qa/neu_gis_qa/1/cog/1992846896224792576/wjuxrczu",
"protoc": 2,
"bbox": [
35.53245,
27.54108,
35.53916,
27.547153
],
"minZoom": 15,
"maxZoom": 20,
"baseUrl": "https://eo.origen.ae/domSliceResult/mosaicjson/WMTSCapabilities.xml",
"layerName": "https://eo.origen.ae/gis_platform/eo-qa/neu_gis_qa/1/cog/1992846896224792576/wjuxrczu",
"metadataName": null,
"geoThumbnailPath": "https://eo.origen.ae/gis_platform/eo-qa/neu_gis_qa/thumbnail/1992846896224792576/thumbnail.jpeg"
}
}
}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 details for a specific metadata
- User authentication is required
- Metadata ID must be provided as query parameter
- Returns detailed information about metadata and 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