Download OpenAPI specification:Download
Mapray Datasets API はGeoJSONフォーマットを基本とした地図データの管理機能を提供します。
Response body | HTTP status code | 説明 |
---|---|---|
invalid request | 400 | 無効なリクエスト |
unauthorized | 401 | 権限がありません |
not found | 404 | 該当データが存在しません |
userIDに紐づくdatasetリストを取得します。
userID required | string 対象データが紐づいているユーザーID |
page | integer >= 1 Default: 1 1ページの要素数がlimitの場合のページ番号 |
limit | integer [ 1 .. 100 ] Default: 5 1ページの要素数 |
sort | string Default: "updatedAt" Enum: "id" "name" "updatedAt" ソートを行うプロパティ |
direction | string Default: "desc" Enum: "asc" "desc" ソート方向 |
[- {
- "id": "3843949342039493",
- "owner_id": "5884034982304942",
- "name": "2D dataset",
- "description": "example",
- "bounds": [
- 0,
- 0,
- 0,
- 0
], - "features": [
- "6044913204461568"
], - "created_at": "2019-03-11T11:09:17.855Z",
- "updated_at": "2019-03-11T11:09:17.855Z",
- "status": "ready",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}, - {
- "id": "4893105706762240",
- "owner_id": "5884034982304942",
- "name": "test",
- "description": "test data",
- "bounds": [
- 0,
- 0,
- 0,
- 0
], - "features": [
- "5634474104586240"
], - "created_at": "2021-06-28T15:39:21.792218Z",
- "updated_at": "2021-06-28T15:39:21.792218Z",
- "status": "ready",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
]
datasetを作成します。
userID required | string 新しいデータを生成したいターゲットのユーザーID |
name required | string [ 1 .. 128 ] characters 名前 |
description required | string [ 0 .. 300 ] characters Default: "" 説明 |
src_file_type | string Default: "geojson" Enum: "json" "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット |
dst_file_type | string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット |
srid required | number (srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 3097 3098 3099 3100 3101 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 4326 32651 32652 32653 32654 32655 32656 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。 |
geoid required | string Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル |
Array of objects (attributions) |
{- "name": "2D dataset",
- "description": "example",
- "srid": 4326,
- "geoid": "EGM96_15",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
{- "id": "3843949342039493",
- "owner_id": "5884034982304942",
- "name": "2D dataset",
- "description": "example",
- "bounds": [
- 0,
- 0,
- 0,
- 0
], - "features": [
- "6044913204461568"
], - "created_at": "2019-03-11T11:09:17.855Z",
- "updated_at": "2019-03-11T11:09:17.855Z",
- "status": "ready",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
指定したdatasetの情報を取得します。
userID required | string datasetを取得したいユーザーのID |
datasetID required | string datasetを取得したいデータセットのID |
{- "id": "3843949342039493",
- "owner_id": "5884034982304942",
- "name": "2D dataset",
- "description": "example",
- "bounds": [
- 0,
- 0,
- 0,
- 0
], - "features": [
- "6044913204461568"
], - "created_at": "2019-03-11T11:09:17.855Z",
- "updated_at": "2019-03-11T11:09:17.855Z",
- "status": "ready",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
Request bodyで指定した内容にDatasetを更新します。
※部分更新はできません
userID required | string 更新したいdatasetのユーザーのID |
datasetID required | string 更新したいデータセットのID |
name required | string [ 1 .. 128 ] characters 名前 |
description | string [ 0 .. 300 ] characters 説明 |
Array of objects (attributions) |
{- "name": "2D dataset update",
- "description": "example update",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
{- "id": "3843949342039493",
- "owner_id": "5884034982304942",
- "name": "2D dataset update",
- "description": "example update",
- "bounds": [
- 0,
- 0,
- 0,
- 0
], - "features": [
- "6044913204461568"
], - "created_at": "2019-03-11T11:09:17.855Z",
- "updated_at": "2019-04-08T18:35:02.322Z",
- "status": "ready",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
Dataset をコンバートリクエスト前の状態に戻します。 再度ファイルをアップロードする必要があります。
userID required | string リセットしたいターゲットのユーザーID |
datasetID required | string リセットしたいデータセットのID |
name required | string [ 1 .. 128 ] characters 名前 |
description required | string [ 0 .. 300 ] characters Default: "" 説明 |
src_file_type | string Default: "geojson" Enum: "json" "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット |
dst_file_type | string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット |
srid required | number (srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 3097 3098 3099 3100 3101 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 4326 32651 32652 32653 32654 32655 32656 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。 |
geoid required | string Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル |
Array of objects (attributions) |
{- "name": "2D dataset",
- "description": "example",
- "srid": 4326,
- "geoid": "EGM96_15",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
{- "id": "3843949342039493",
- "owner_id": "5884034982304942",
- "name": "2D dataset",
- "description": "example",
- "bounds": null,
- "features": null,
- "created_at": "2019-03-11T11:09:17.855Z",
- "updated_at": "2019-03-11T11:09:17.855Z",
- "status": "before_queued",
- "attributions": [
- {
- "display": "©Mapray",
- "description": "Mapray",
}
]
}
2DファイルをアップロードするためのURLを取得し、データを送信することでアップロードできます。
userID required | string 対象データが紐づいているユーザーID |
datasetID required | string 指定するdatasetのID |
アップロードするファイル情報
filename required | string ファイル名 |
content_type required | string ファイルのContent-Type https://www.iana.org/assignments/media-types/media-types.xhtml |
[- {
- "filename": "test.kml",
- "content_type": "application/xml"
}, - {
- "filename": "test.gpx",
- "content_type": "application/xml"
}
]
[- {
- "filename": "test.kml",
- "content_type": "application/xml",
}, - {
- "filename": "test.gpx",
- "content_type": "application/xml",
}
]
ファイルアップロードを実行します。
upload_url required | string Create Upload URLで取得したUpload URL |
Content-Type required | string URL生成時に指定したContent-Type |
アップロードするデータ
<?xml version='1.0' encoding='UTF-8'?> <Error> <Code>ExpiredToken</Code> <Message>The provided token has expired.</Message> <Details>Request signature expired at: 2021-07-01T10:00:00+00:00</Details> </Error>
datasetIDに紐づくfeaturesのリストを取得します。
userID required | string リストを取得したいユーザーのID |
datasetID required | string リストを取得したいデータセットのID |
[- {
- "type": "FeatureCollection",
- "mapray": {
- "id": "5100199366098944",
- "version": "1.0"
}, - "features": [
- {
- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "id": "geo json id",
- "mapray": {
- "id": "62707111317995529",
- "version": "1.0"
}
}, - {
- "type": "Feature",
- "geometry": {
- "type": "Point",
- "coordinates": [
- 138.73090982437134,
- 35.36284101638963
]
}, - "properties": { },
- "id": "geo json id",
- "mapray": {
- "id": "5949055528075264",
- "version": "1.0",
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
]
}
]
GeoJSONのfeatureをdatasetに追加します。
userID required | string featureをdatasetに追加したいユーザーのID |
datasetID required | string featureを追加するdatasetのID |
GeoJSON featureを指定します。
1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。
id | string |
geometrty | object |
properties | object |
object |
{- "id": "5100199366098944",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "mapray": {
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
{- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "id": "geo json id",
- "mapray": {
- "id": "62707111317995529",
- "version": "1.0",
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
GeoJSONのfeatureをdatasetに追加します。
userID required | string featureをdatasetに追加したいユーザーのID |
datasetID required | string featureを追加するdatasetのID |
GeoJSON featureを指定します。
1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。
id | string |
geometrty | object |
properties | object |
object |
[- {
- "id": "5100199366098944",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "mapray": {
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
]
[- {
- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "id": "geo json id",
- "mapray": {
- "id": "62707111317995529",
- "version": "1.0",
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
]
Featureを更新します。 Request Bodyで指定した内容に置き換わります。 (部分更新はできません)
userID required | string featureを置き換えるユーザーのID |
maprayFeatureID required | string 置き換えるfeatureのmaprayFeatureID |
GeoJSON featureを指定します。 1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。
id | string |
geometrty | object |
properties | object |
object |
{- "id": "62707111317995529",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "mapray": {
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
{- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "id": "geo json id",
- "mapray": {
- "id": "62707111317995529",
- "version": "1.0",
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
指定したfeatureを取得します。
userID required | string datasetに紐づくユーザーのID |
maprayFeatureID required | string 取得するfeatureのID |
{- "type": "Feature",
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 139.87997889518738,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63146248978614
], - [
- 139.88187789916992,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63247402587776
], - [
- 139.87997889518738,
- 35.63146248978614
]
]
]
}, - "properties": {
- "stroke": "#555555",
- "stroke-width": 2,
- "stroke-opacity": 1,
- "fill": "#0d5fe3",
- "fill-opacity": 0.5
}, - "id": "geo json id",
- "mapray": {
- "id": "62707111317995529",
- "version": "1.0",
- "visibility": true,
- "altitudeMode": "CLAMP"
}
}
指定した2D datasetのコンバート情報を取得します。
userID required | string 対象データが紐づいているユーザーID |
datasetID required | string 指定するdatasetのID |
{- "id": "6833388005240832",
- "jobType": "",
- "userID": "4098494030324145",
- "3DDatasetID": "4811188005240832",
- "inputFilePath": "dummy.appspot.com/dataset/4098494030324145/4811188005240832/input",
- "outputFilePath": "dummy.appspot.com/dataset/4098494030324145/4811188005240832/output",
- "error": "",
- "startAt": "2017-09-04T05:56:10Z",
- "finishAt": "2017-09-04T05:57:15Z",
- "status": "ready"
}