URI
<tileJobs_uri>/{jobid}[.<format>]
Supported methods
Parent resource
Child resources
Introduction
Returns the status and information of the specified tile task.
Supported Methods:
- GET: Returns the status and information of the specified tile task.
- PUT: Updates the running status of the specified tile task, either enable/stop task.
- DELETE: Deletes the specified tile task.
- HEAD: Checks whether the tileJob resource exists or whether it has permission to access the resource.
Supported output formats: rjson, json, html, xml.
Resource hierarchy
HTTP request methods
Implement the HTTP request on the following URI, where supermapiserver is the server name and c9575f3c-c417-4ef9-a4da-9b0aa2c68d32 is the tile task ID, with rjson being the output format.
http://supermapiserver:8090/iserver/manager/tileservice/jobs/c9575f3c-c417-4ef9-a4da-9b0aa2c68d32.rjson
GET request
Returns the status and information of the specified tile task.
Response structure
Fields for the returned status and information of the specified tile task include:
| Field | Type | Description |
| id | String | The tiling task ID. |
| state | JobState | The current status for the tiling task. |
| info | JobInfo | The basic information of the tiling task. |
Response example
Suppose we implement the GET request on http://localhost:8090/iserver/manager/tileservice/jobs/c9575f3c-c417-4ef9-a4da-9b0aa2c68d32.rjson, which is the result of the POST request on tileJobs, the returned rjson format response restult is as follows:
{
"id": "c9575f3c-c417-4ef9-a4da-9b0aa2c68d32",
"info": {
"actualTileVersion": "119df1b3-03f8-46de-b194-4f4e0473c9d8",
"cacheBounds": {
"bottom": -2.003750834278914E7,
"left": -2.0037508342789244E7,
"leftBottom": {
"x": -2.0037508342789244E7,
"y": -2.003750834278914E7
},
"right": 2.0037508342789244E7,
"rightTop": {
"x": 2.0037508342789200.0037508342789244E7,
"y": 2.0037508342789100.003750834278914E7
},
"top": 2.0037508342789095E7
},
"createNewTileVersion": false,
"dataConnectionString": "../../samples/data/China400/China400.smwu",
"epsgCode": -1,
"format": "PNG",
"mapName": "China",
"originalPoint": {
"x": -2.0037508342789244E7,
"y": 2.0037508342789100.003750834278914E7
},
"parentTileVersion": null,
"refMapRestAdress": "http://localhost:8090/iserver/services/map-china400/rest/maps/China",
"resolutions": [317.50000000000000],
"scaleDenominators": [1200000],
"storageID": "aa",
"storeConfig": {
"fdfsTrackers": ["192.168.122.44:22122"],
"fdhtGroups": [
["192.168.122.44:11411"]
],
"type": "FastDFS"
},
"tileSize": "SIZE_256",
"transparent": false
},
"state": {
"analystBlankPercentage": 0,
"buildingScale": {
"completed": 16680,
"completedBytes": 0,
"completedRegion": null,
"failedRegion": null,
"matrixes": [{
"columnCount": 494,
"rowCount": 494,
"startingIndex": {
"columnIndex": 0,
"rowIndex": 0
}
}],
"nextIndex": {
"columnIndex": 360,
"rowIndex": 20
},
"scaleDenominator": 1200000,
"total": 244036,
"totalMatrix": null,
"workerBuildingInfos": [{
"completed": 16680,
"id": "39df3c13-e6bc-49de-89e2-13e0e1978d8c",
"ip": "192.168.120.40",
"lastTileRegion": null,
"name": "worker1",
"port": 8090
}]
},
"completed": 16680,
"completedBytes": 9622888,
"completedScale": [],
"deployedWorkerId": ["39df3c13-e6bc-49de-89e2-13e0e1978d8c"],
"elapsedTime": 222260,
"masterAddress": "http://localhost:8090/iserver/services/tilemaster",
"remainTime": 3016279,
"runState": "BUILDING",
"scaleConfigs": [{
"cacheRegions": [],
"excludeRegions": [],
"scaleDenominator": 1200000,
"tileBoundsHeight": "81279.99999999999",
"tileBoundsWidth": "81279.99999999999"
}],
"scaleInfos": [{
"completed": 16680,
"completedBytes": 9622888,
"completedRegion": null,
"failedRegion": null,
"matrixes": [{
"columnCount": 494,
"rowCount": 494,
"startingIndex": {
"columnIndex": 0,
"rowIndex": 0
}
}],
"scaleDenominator": 1200000,
"total": 244036,
"totalMatrix": null,
"workerBuildingInfos": [{
"completed": 16680,
"id": "39df3c13-e6bc-49de-89e2-13e0e1978d8c",
"ip": "192.168.120.40",
"lastTileRegion": null,
"name": "worker1",
"port": 8090
}]
}],
"speedPerSecond": 75,
"tasks": [{
"deployTime": 0,
"id": "eefe2a43-4e2c-48b0-b9a8-03315658cde2",
"isRetile": false,
"jobId": "c9575f3c-c417-4ef9-a4da-9b0aa2c68d32",
"masterAddress": "http://localhost:8090/iserver/services/tilemaster",
"scaleConfig": {
"cacheRegions": [],
"excludeRegions": [],
"scaleDenominator": 1200000,
"tileBoundsHeight": "81279.99999999999",
"tileBoundsWidth": "81279.99999999999"
},
"state": {
"completed": 0,
"lastIndex": null,
"runState": null,
"workerId": null
},
"tileMatrixToBuild": {
"columnCount": 20,
"rowCount": 20,
"startingIndex": {
"columnIndex": 340,
"rowIndex": 20
}
},
"totalTileCount": 400
}],
"tasksToRetry": [],
"tileMatrixEdgeCount": 20,
"total": 244036
}
}
PUT request
Updates the running status of the specified tile task, either enable/stop task.
Request parameter
Parameters passed in the request body are as follows:
| Field | Type | Description |
| STOPPED | BuildState | The status information of the tile task. Pause the specified tile task. |
Response structure
The returned representation structure is as follows after implementing the PUT request on the tileJob resource (representation is in the entity body of the response message):
| Field | Type | Description |
| succeed | boolean | Whether the status information of the specified tile task has been successfully updated. |
Example usage
Suppose we plan to implement the PUT request on the tileJob resource http://localhost:8090/iserver/manager/tileservice/jobs/c9575f3c-c417-4ef9-a4da-9b0aa2c68d32.rjson and we pass in following parameters:
STOPPED
The response result returned in rjson format is as follows:
{"succeed": true}
DELETE request
Deletes the specified tile task.
Response structure
The returned representation structure is as follows after implementing the DELETE request on the tileJob resource (representation is in the entity body of the response message):
| Field | Type | Description |
| succeed | boolean | Whether the specified tile task has been successfully deleted. |
Response example
Suppose we implement the DELETE request on the tileJob resource http://localhost:8090/iserver/manager/tileservice/jobs/c9575f3c-c417-4ef9-a4da-9b0aa2c68d32.rjson to delete the specified tile task, the returned rjson format response result is as follows:
{"succeed": true}
HEAD request
Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.
HEAD request can be used to check if the tileJob resource exists, or if the tileJob resource can be accessed by clients. It can also determine if the tileJob resource supports an output format <format> if performed on a URI with .<format> included.