Mapray Dataset API (2.0.0)

Download OpenAPI specification:Download

Mapray Datasets API はGeoJSONフォーマットを基本とした地図データの管理機能を提供します。

ファイルのアップロード手順

2D Datasetの作成
2D DatasetのIDを用いてファイルアップロード用のURLを取得
アップロード用のURLにファイルをアップロード
データをコンバート

エラー一覧

Response body	HTTP status code	説明
invalid request	400	無効なリクエスト
unauthorized	401	権限がありません
not found	404	該当データが存在しません

dataset2dv2

Mapray Dataset API (2.0.0)

List Datasets

認証情報から得たorganizationIDに紐づく全てのdatasetリストを取得します。

Authorizations:

OAuthApi-Key

query Parameters

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" ソート方向

Responses

Response samples

200

Content type

application/json

[{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
},
{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}
]

Create Dataset

認証情報から得たorganizationIDに紐づく新しいdatasetを作成します。

Authorizations:

OAuthApi-Key

path Parameters

userID

required

string

新しいデータを生成したいターゲットのユーザーID

Request Body schema: application/json

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)

Responses

Request samples

Payload

Content type

application/json

{"name": "2D dataset",
"description": "example",
"srid": 4326,
"geoid": "EGM96_15",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Count Datasets

認証情報から得たorganizationIDに紐づくdatasetの数を取得します。

Authorizations:

OAuthApi-Key

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Dataset

指定したdatasetの情報を取得します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string datasetを取得したいユーザーのID
datasetID required	string datasetを取得したいデータセットのID

Responses

Response samples

200

Content type

application/json

{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Update Dataset

Request bodyで指定した内容にDatasetを更新します。

※部分更新はできません

Authorizations:

OAuthApi-Key

path Parameters

userID required	string 更新したいdatasetのユーザーのID
datasetID required	string 更新したいデータセットのID

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前
description	string [ 0 .. 300 ] characters 説明
	Array of objects (attributions)

Responses

Request samples

Payload

Content type

application/json

{"name": "2D dataset update",
"description": "example update",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Reset Dataset

Dataset をコンバートリクエスト前の状態に戻します。再度ファイルをアップロードする必要があります。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string リセットしたいターゲットのユーザーID
datasetID required	string リセットしたいデータセットのID

Request Body schema: application/json

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)

Responses

Request samples

Payload

Content type

application/json

{"name": "2D dataset",
"description": "example",
"srid": 4326,
"geoid": "EGM96_15",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"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",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Delete Dataset

指定したdatasetを削除します。

featuresも同時に削除されます。

一度削除したファイルは元に戻すことはできません。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string 削除したいdatasetの所有者のユーザーのID
datasetID required	string 削除したいデータセットのID

Responses

Response samples

200

Content type

application/json

{ }

Create Upload URL

2DファイルをアップロードするためのURLを取得し、データを送信することでアップロードできます。

アップロードファイルごとにURLを取得します。
upload URLの有効期間は15分になります。
同一のupload URLは有効期間内であれば何回でも使用できます。
upload URLは何回でも作り直せます。

Authorizations:

OAuthApi-Key

path Parameters

datasetID

required

string

指定するdatasetのID

Request Body schema: application/json
required

アップロードするファイル情報

Array

filename required	string ファイル名
content_type required	string ファイルのContent-Type https://www.iana.org/assignments/media-types/media-types.xhtml

Responses

Request samples

Payload

Content type

application/json

[{"filename": "test.kml",
"content_type": "application/xml"
},
{"filename": "test.gpx",
"content_type": "application/xml"
}
]

Response samples

200

Content type

application/json

[{"filename": "test.kml",
"content_type": "application/xml",
"url": "https://storage.googleapis.com/bucket/test.kml?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
},
{"filename": "test.gpx",
"content_type": "application/xml",
"url": "https://storage.googleapis.com/bucket/test.gpx?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Get Dataset File List

指定したdatasetのファイル一覧情報を取得します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string datasetのファイル一覧を取得したいユーザーのID
datasetID required	string datasetのファイル一覧を取得したいデータセットのID

Responses

Response samples

200

Content type

application/json

["test.kml",
"test.gpx"
]

Upload 2D Data

ファイルアップロードを実行します。

生成したURLにデータを送信します。
multipart/form-dataではアップロードできないため、URLに対して生成時に指定したContent-Typeを指定してください。

path Parameters

upload_url

required

string

Create Upload URLで取得したUpload URL

header Parameters

Content-Type

required

string

URL生成時に指定したContent-Type

Request Body schema: application/octet-stream

object

アップロードするデータ

Responses

Request samples

Payload

Content type

application/octet-stream

No sample

Response samples

400

Content type

application/xml

<?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>

List Features

datasetIDに紐づくすべてのfeaturesリストを取得します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string リストを取得したいユーザーのID
datasetID required	string リストを取得したいデータセットのID

Responses

Response samples

200

Content type

application/json

[{"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",
"visibility": true,
"altitudeMode": "CLAMP"
}
},
{"type": "Feature",
"geometry": {"type": "Point",
"coordinates": [138.73090982437134,
35.36284101638963
]
},
"properties": { },
"id": "geo json id",
"mapray": {"id": "5949055528075264",
"version": "1.0"
}
}
]
}
]

Insert Feature

GeoJSONのfeatureをdatasetに追加します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string featureをdatasetに追加したいユーザーのID
datasetID required	string featureを追加するdatasetのID

Request Body schema: application/json

GeoJSON featureを指定します。

1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。

id	string
geometrty	object
properties	object
	object

Responses

Request samples

Payload

Content type

application/json

{"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"
}
}

Response samples

200

Content type

application/json

{"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"
}
}

Insert MultiFeatures

GeoJSONのfeatureをdatasetに追加します。

Authorizations:

OAuthApi-Key

path Parameters

datasetID

required

string

featureを追加するdatasetのID

Request Body schema: application/json
required

GeoJSON featureを指定します。

1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。

Array

id	string
geometrty	object
properties	object
	object

Responses

Request samples

Payload

Content type

application/json

[{"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"
}
}
]

Response samples

200

Content type

application/json

[{"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"
}
}
]

Update Feature

Featureを更新します。 Request Bodyで指定した内容に置き換わります。（部分更新はできません）

Authorizations:

OAuthApi-Key

path Parameters

userID required	string featureを置き換えるユーザーのID
maprayFeatureID required	string 置き換えるfeatureのmaprayFeatureID

Request Body schema: application/json

GeoJSON featureを指定します。 1つのfeatureにつき1MBの上限があり、その他のパラメータで300B程度あらかじめ使用されます。

id	string
geometrty	object
properties	object
	object

Responses

Request samples

Payload

Content type

application/json

{"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"
}
}

Response samples

200

Content type

application/json

{"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"
}
}

Retrieve Feature

指定されたuserIDが持つdatasetIDに対してfeatureIDで指定されたfeatureを取得します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string datasetに紐づくユーザーのID
maprayFeatureID required	string 取得するfeatureのID

Responses

Response samples

200

Content type

application/json

{"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"
}
}

Delete Feature

指定したfeatureを削除します。

Authorizations:

OAuthApi-Key

path Parameters

userID required	string datasetに紐づくユーザーのID
maprayFeatureID required	string 削除するfeatureのID

Responses

Response samples

200

Content type

application/json

{ }

Convert 2D Dataset

2D datasetのコンバートを開始します。

Authorizations:

OAuthApi-Key

path Parameters

datasetID

required

string

指定するdatasetのID

Responses

Retrieve 2D Dataset Convert Status

指定した2D datasetのコンバート情報を取得します。

Authorizations:

OAuthApi-Key

path Parameters

datasetID

required

string

指定するdatasetのID

Responses

Response samples

200

Content type

application/json

{"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"
}

Mapray Dataset API (2.0.0)

ファイルのアップロード手順

エラー一覧

dataset2dv2

List Datasets

Authorizations:

query Parameters

Responses

Response samples

Create Dataset

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Count Datasets

Authorizations:

Responses

Response samples

Retrieve Dataset

Authorizations:

path Parameters

Responses

Response samples

Update Dataset

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Reset Dataset

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Dataset

Authorizations:

path Parameters

Responses

Response samples

Create Upload URL

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Dataset File List

Authorizations:

path Parameters

Responses

Response samples

Upload 2D Data

path Parameters

header Parameters

Request Body schema: application/octet-stream

Responses

Request samples

Response samples

List Features

Authorizations:

path Parameters

Responses

Response samples

Insert Feature

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Insert MultiFeatures

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required