Mapray API (2.0.0)

Download OpenAPI specification:Download

2D Datasets V2

Mapray Dataset API (2.0.0)

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

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

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

エラー一覧

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

List Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

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:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (2DSrid) Default: 4326 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	string Default: "EGM96_15" Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル。
src_file_type	string Default: "geojson" Enum: "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット。
dst_file_type	string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット。

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:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (2DSrid) Default: 4326 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	string Default: "EGM96_15" Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル。
src_file_type	string Default: "geojson" Enum: "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット。
dst_file_type	string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット。

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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

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
400

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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetのID。

Responses

Response samples

200

Content type

application/json

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

List Features

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetの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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定する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:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定する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:

Api-KeyOrganization-Token

path Parameters

maprayFeatureID

required

string

指定するfeatureの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": "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:

Api-KeyOrganization-Token

path Parameters

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:

Api-KeyOrganization-Token

path Parameters

maprayFeatureID

required

string

指定するfeatureのID。

Responses

Response samples

200

Content type

application/json

{ }

Convert 2D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

datasetID

required

string

指定するdatasetのID。

Responses

Retrieve 2D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

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

Upload 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

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>

3D Datasets V2

Mapray 3D Dataset API (2.0.0)

Mapray 3D Dataset API は３次元地理空間情報データの管理機能を提供します。

3D datasetは3次元データを意味しており、3D datasetオブジェクトはmaprayJSで利用されるmaprayシーンファイルに相当します。

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

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

エラー一覧

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

List 3D Datasets

組織に紐づく全ての3D datasetリストを取得します。

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v2/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}
]

Create 3D Dataset

新しい3D datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
altitude_mode	string Default: "absolute" Enum: "absolute" "relative" "clamp" sridで指定した座標系で高度の基準。
src_file_type required	string Enum: "glTF" "obj" コンバート前のデータフォーマット。
dst_file_type	string Default: "glTF" コンバート後のデータフォーマット。
path	string 関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない。
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"src_file_type": "glTF",
"dst_file_type": "glTF",
"scene_id": "0",
"srid": 4326,
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"url": "3ddatasets/v2/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Count 3D Datasets

組織に紐づく3D datasetの数を取得します。

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v2/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Update 3D Dataset

3D datasetのプロパティを更新します。 request bodyで指定した3D datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"scene_id": "0",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v2/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Delete 3D Dataset

指定した3D datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
altitude_mode	string Default: "absolute" Enum: "absolute" "relative" "clamp" sridで指定した座標系で高度の基準。
src_file_type required	string Enum: "glTF" "obj" コンバート前のデータフォーマット。
dst_file_type	string Default: "glTF" コンバート後のデータフォーマット。
path	string 関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない。
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"src_file_type": "glTF",
"dst_file_type": "glTF",
"scene_id": "0",
"srid": 4326,
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"url": "3ddatasets/v2/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Create Upload URL

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

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

例: sampleディレクトリのファイルをアップロードする場合

  /home
  └── user
      └── sample
          ├── test.gltf
          └── texture
              └── test.png

ファイルフォーマットごとに注意点がありますが、例えばglTFファイルはglTFにリンクされるbinファイル、テクスチャファイルへのパスが記述されますが、これらのパスはglTF本体からの相対パスが指定されている必要があります。

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3Ddatasetの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.glTF",
"content_type": "model/gltf+json"
},
{"filename": "texture/test.png",
"content_type": "image/png"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "test.glTF",
"content_type": "model/gltf+json",
"url": "https://storage.googleapis.com/bucket/test.glTF?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
},
{"filename": "texture/test.png",
"content_type": "image/png",
"url": "https://storage.googleapis.com/bucket/test.png?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Responses

Retrieve 3D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005540832",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/3ddataset/4098494030324145/4811188005240832",
"outputFilePath": "dummy.appspot.com/3ddataset/4098494030324145/4811188005240832/output",
"error": "",
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:10Z",
"options": [{"flag": "entity-id",
"value": "5146998000844800"
}
],
"status": "queued"
}

Retrieve Mapray Scene Data

mapray scene フォーマットのJSONを取得する。

Authorizations:

Api-KeyOrganization-Token

path Parameters

3ddatasets_ids

required

string

query Parameters

3ddatasets_ids

required

integer

Example: 3ddatasets_ids=5106328150212608,5665678182842368

取得する3DdatasetIDの配列（カンマ区切り、要素数は1以上）

Responses

Response samples

200

Content type

application/json

{"model_register": {"5171376604315648": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5171376604315648/scene.gltf"
},
"5646954843340800": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5646954843340800/scene.gltf"
},
"5665941954232320": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5665941954232320/scene.gltf"
},
"5676392851177472": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5676392851177472/scene.gltf"
}
},
"entity_list": [{"type": "model",
"transform": {"position": [130.874242,
33.884403,
2
]
},
"ref_model": "5171376604315648",
"index": 0
},
{"type": "model",
"transform": {"position": [138.712371,
35.506622,
849
]
},
"ref_model": "5646954843340800"
},
{"type": "model",
"transform": {"position": [138.710371,
35.506622,
888
]
},
"ref_model": "5665941954232320",
"index": 0
},
{"type": "model",
"transform": {"position": [138.710371,
35.506622,
2000
]
},
"ref_model": "5676392851177472",
"index": 0
}
]
}

List Blob Files

3ddatasetIDに紐づく全てのblobfileのパスとblobfile IDを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID

required

string

指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"/main/main.gltf": "5171376604315648",
"/texture/image0.jpg": "5646954843340800",
"/texture/image1.jpg": "5676392851177472"
}

Retrieve Blob File

アップロードしたファイルをダウンロードします。

Authorizations:

Api-KeyOrganization-Token

path Parameters

3DdatasetID required	string 指定する3DdatasetのID。
path required	string 指定するファイルパス。

Responses

Upload 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

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>

PC Datasets V2

Mapray Point Cloud Dataset API (2.0.0)

Mapray Point Cloud Dataset API は３次元地理空間の点群データの管理機能を提供します。

PC Datasetは3次元の点群データを意味します。

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

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

エラー一覧

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

List PC Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}
]

Create PC Dataset

新しいPC datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type required	string Enum: "e57" "las" "laz" "ply" "pts" "ptx" "xyz" コンバート前のデータフォーマット。
dst_file_type	string Default: "raw" Value: "raw" コンバート後のデータフォーマット。
	object ローカル座標の原点。（sridを指定しない場合に必要）
	object 点群の回転。（sridを指定しない場合に必要）
scale	number Default: 1 点群のスケール。（sridを指定しない場合に必要）
xyz_type	integer [ 1 .. 8 ] xyzフォーマットの種類番号。入力ファイルがxyz形式の場合に必要。（1:XYZ, 2:XYZRGB, 3:XYZIRGB, 4:XYZI, 5:XYZNxNyNzRGB, 6:XYZNxNyNzIRG, 7:XYZRGBNxNyNz, 8:XYZIRGBNxNyNz）
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"src_file_type": "las",
"dst_file_type": "raw",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-12T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Count PC Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Update PC Dataset

PC datasetのプロパティを更新します。 request bodyで指定したPC datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Delete PC Dataset

指定したPC datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type required	string Enum: "e57" "las" "laz" "ply" "pts" "ptx" "xyz" コンバート前のデータフォーマット。
dst_file_type	string Default: "raw" Value: "raw" コンバート後のデータフォーマット。
	object ローカル座標の原点。（sridを指定しない場合に必要）
	object 点群の回転。（sridを指定しない場合に必要）
scale	number Default: 1 点群のスケール。（sridを指定しない場合に必要）
xyz_type	integer [ 1 .. 8 ] xyzフォーマットの種類番号。入力ファイルがxyz形式の場合に必要。（1:XYZ, 2:XYZRGB, 3:XYZIRGB, 4:XYZI, 5:XYZNxNyNzRGB, 6:XYZNxNyNzIRG, 7:XYZRGBNxNyNz, 8:XYZIRGBNxNyNz）
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"src_file_type": "las",
"dst_file_type": "raw",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-12T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetの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.las",
"content_type": "application/octet-stream"
}
]

Response samples

200
400

Content type

application/json

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

Convert PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Responses

Retrieve PC Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID

required

string

指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005540832",
"userID": "6252052887896064",
"3DDatasetID": "6252052887896064",
"inputFilePath": "dummy.appspot.com/pcdataset/6252052887896064/6252052887896064/input",
"outputFilePath": "dummy.appspot.com/pcdataset/6252052887896064/6252052887896064/output",
"error": "",
"startAt": "2021-08-12T02:58:27.377537Z",
"finishAt": "2021-08-12T02:59:27.377537Z",
"options": [{"flag": "jzone",
"value": "1"
}
],
"status": "ready"
}

Download PC Dataset source file

指定したPC datasetのソースファイルをダウンロードするためのURLにリダイレクトします。

Authorizations:

Api-KeyOrganization-Token

path Parameters

PCdatasetID required	string 指定するPCdatasetのID。
path/to/file required	string 指定するファイルパス。

Responses

Upload 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

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>

B3D Datasets V2

Mapray Building 3D Dataset API (2.0.0)

Mapray Building 3D Dataset API は３次元地理空間の建物3Dデータの管理機能を提供します。

Building 3D Datasetは3次元の建物3Dデータを意味します。

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

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

エラー一覧

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

List B3D Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}
]

Create B3D Dataset

新しいB3D datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid required	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "gml" Value: "gml" コンバート前のデータフォーマット。
dst_file_type	string Default: "b3d" Value: "b3d" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"src_file_type": "gml",
"dst_file_type": "b3d"
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Count B3D Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Update B3D Dataset

B3D datasetのプロパティを更新します。 request bodyで指定したB3D datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Delete B3D Dataset

指定したB3D datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid required	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "gml" Value: "gml" コンバート前のデータフォーマット。
dst_file_type	string Default: "b3d" Value: "b3d" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"src_file_type": "gml",
"dst_file_type": "b3d"
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3Ddatasetの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.gml",
"content_type": "application/gml+xml"
}
]

Response samples

200
400

Content type

application/json

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

Convert B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Responses

Retrieve B3D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

B3DdatasetID

required

string

指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005240832",
"jobType": "",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/b3ddataset/4098494030324145/4811188005240832/input",
"outputFilePath": "dummy.appspot.com/b3ddataset/4098494030324145/4811188005240832/output",
"options": null,
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:15Z",
"status": "ready",
"error": ""
}

Upload 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

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>

Tileset Datasets V2

Mapray Tileset API (2.0.0)

Mapray Tileset API はラスターおよびベクター地理空間情報データの管理機能を提供します。

Tileset Datasetはラスターおよびベクター地理空間情報データを意味します。

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

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

エラー一覧

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

List Tilesets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "5979479326288593",
"owner_id": "6062859285729275",
"created_at": "2022-03-30T05:03:52.761984Z",
"updated_at": "2022-03-30T05:03:52.761984Z",
"url": "https://dummy.appspot.com/tileset/5979479326288593/",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"statuses": [{"type": "tiles",
"status": "queued"
}
],
"info": {"description": "./ortho-dem.tif",
"driverShortName": "GTiff",
"driverLongName": "GeoTIFF",
"files": ["./ortho-dem.tif"
],
"size": [[4289,
5612
]
],
"coordinateSystem": {"wkt": "string",
"dataAxisToSRSAxisMapping": [[2,
1
]
]
},
"geoTransform": [[140.43392886025845,
0.0000013227283488,
0,
35.84971998769358,
0,
-0.0000010769339717
]
],
"metadata": { },
"cornerCoordinates": {"upperLeft": [[140.4339289,
35.84972
]
],
"lowerLeft": [[140.4339289,
35.8436762
]
],
"lowerRight": [0
],
"upperRight": [[140.439602,
35.84972
]
],
"center": [[140.4367655,
35.8466981
]
]
},
"wgs84Extent": {"type": "Polygon",
"coordinates": [[0
]
]
},
"bands": [{"band": 1,
"block": [[256,
256
]
],
"type": "Float32",
"colorInterpretation": "Gray",
"noDataValue": -32767,
"overviews": [{"size": [0
]
}
],
"unit": "string",
"metadata": { }
}
]
},
"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000,
"bounds": [139.5,
35.5,
139.6,
35.6
],
"minzoom": 10,
"maxzoom": 15
},
"image": {"format": "png",
"bounds": [139.5,
35.5,
139.6,
35.6
],
"minzoom": 10,
"maxzoom": 15
}
}
]

Create Tileset Dataset

新しいTileset datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (TilesetSrid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "geotiff" Value: "geotiff" コンバート前のデータフォーマット。
	object (TilesetTilesOption)
	TilesetContourOption (object) or TilesetContourOption (object) or TilesetContourOption (object) (TilesetContourOption) gdal_contour用のオプション。
	object (TilesetHeightmapOption)
	object (TilesetImageOption)

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000
},
"image": {"format": "png"
},
"src_file_type": "geotiff",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5979479326288593",
"owner_id": "6062859285729275",
"created_at": "2022-03-30T05:03:52.761984Z",
"updated_at": "2022-03-30T05:03:52.761984Z",
"url": "https://dummy.appspot.com/tileset/5979479326288593/",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"statuses": [{"type": "tiles",
"status": "queued"
}
],
"info": {"description": "./ortho-dem.tif",
"driverShortName": "GTiff",
"driverLongName": "GeoTIFF",
"files": ["./ortho-dem.tif"
],
"size": [[4289,
5612
]
],
"coordinateSystem": {"wkt": "string",
"dataAxisToSRSAxisMapping": [[2,
1
]
]
},
"geoTransform": [[140.43392886025845,
0.0000013227283488,
0,
35.84971998769358,
0,
-0.0000010769339717
]
],
"metadata": { },
"cornerCoordinates": {"upperLeft": [[140.4339289,
35.84972
]
],
"lowerLeft": [[140.4339289,
35.8436762
]
],
"lowerRight": [0
],
"upperRight": [[140.439602,
35.84972
]
],
"center": [[140.4367655,
35.8466981
]
]
},
"wgs84Extent": {"type": "Polygon",
"coordinates": [[0
]
]
},
"bands": [{"band": 1,
"block": [[256,
256
]
],
"type": "Float32",
"colorInterpretation": "Gray",
"noDataValue": -32767,
"overviews": [{"size": [0
]
}
],
"unit": "string",
"metadata": { }
}
]
},
"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000
},
"image": {"format": "png"
}
}

Count Tileset Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Tileset Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "5979479326288593",
"owner_id": "6062859285729275",
"created_at": "2022-03-30T05:03:52.761984Z",
"updated_at": "2022-03-30T05:03:52.761984Z",
"url": "https://dummy.appspot.com/tileset/5979479326288593/",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"statuses": [{"type": "tiles",
"status": "queued"
}
],
"info": {"description": "./ortho-dem.tif",
"driverShortName": "GTiff",
"driverLongName": "GeoTIFF",
"files": ["./ortho-dem.tif"
],
"size": [[4289,
5612
]
],
"coordinateSystem": {"wkt": "string",
"dataAxisToSRSAxisMapping": [[2,
1
]
]
},
"geoTransform": [[140.43392886025845,
0.0000013227283488,
0,
35.84971998769358,
0,
-0.0000010769339717
]
],
"metadata": { },
"cornerCoordinates": {"upperLeft": [[140.4339289,
35.84972
]
],
"lowerLeft": [[140.4339289,
35.8436762
]
],
"lowerRight": [0
],
"upperRight": [[140.439602,
35.84972
]
],
"center": [[140.4367655,
35.8466981
]
]
},
"wgs84Extent": {"type": "Polygon",
"coordinates": [[0
]
]
},
"bands": [{"band": 1,
"block": [[256,
256
]
],
"type": "Float32",
"colorInterpretation": "Gray",
"noDataValue": -32767,
"overviews": [{"size": [0
]
}
],
"unit": "string",
"metadata": { }
}
]
},
"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000,
"bounds": [139.5,
35.5,
139.6,
35.6
],
"minzoom": 10,
"maxzoom": 15
},
"image": {"format": "png",
"bounds": [139.5,
35.5,
139.6,
35.6
],
"minzoom": 10,
"maxzoom": 15
}
}

Update Tileset Dataset

Tileset datasetのプロパティを更新します。 request bodyで指定したTileset datasetオブジェクトのデータでデータがすべて更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5979479326288593",
"owner_id": "6062859285729275",
"created_at": "2022-03-30T05:03:52.761984Z",
"updated_at": "2022-03-30T05:03:52.761984Z",
"url": "https://dummy.appspot.com/tileset/5979479326288593/",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"statuses": [{"type": "tiles",
"status": "queued"
}
],
"info": {"description": "./ortho-dem.tif",
"driverShortName": "GTiff",
"driverLongName": "GeoTIFF",
"files": ["./ortho-dem.tif"
],
"size": [[4289,
5612
]
],
"coordinateSystem": {"wkt": "string",
"dataAxisToSRSAxisMapping": [[2,
1
]
]
},
"geoTransform": [[140.43392886025845,
0.0000013227283488,
0,
35.84971998769358,
0,
-0.0000010769339717
]
],
"metadata": { },
"cornerCoordinates": {"upperLeft": [[140.4339289,
35.84972
]
],
"lowerLeft": [[140.4339289,
35.8436762
]
],
"lowerRight": [0
],
"upperRight": [[140.439602,
35.84972
]
],
"center": [[140.4367655,
35.8466981
]
]
},
"wgs84Extent": {"type": "Polygon",
"coordinates": [[0
]
]
},
"bands": [{"band": 1,
"block": [[256,
256
]
],
"type": "Float32",
"colorInterpretation": "Gray",
"noDataValue": -32767,
"overviews": [{"size": [0
]
}
],
"unit": "string",
"metadata": { }
}
]
},
"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000
},
"image": {"format": "png"
}
}

Delete Tileset Dataset

指定したデータセットを削除します。アップロードしたデータ全部を削除します。一度削除したファイルはもとに戻すことができません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Responses

Response samples

200

Content type

application/json

No sample

Reset Tileset Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (TilesetSrid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "geotiff" Value: "geotiff" コンバート前のデータフォーマット。
	object (TilesetTilesOption)
	TilesetContourOption (object) or TilesetContourOption (object) or TilesetContourOption (object) (TilesetContourOption) gdal_contour用のオプション。
	object (TilesetHeightmapOption)
	object (TilesetImageOption)

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000
},
"image": {"format": "png"
},
"src_file_type": "geotiff",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5979479326288593",
"owner_id": "6062859285729275",
"created_at": "2022-03-30T05:03:52.761984Z",
"updated_at": "2022-03-30T05:03:52.761984Z",
"url": "https://dummy.appspot.com/tileset/5979479326288593/",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"statuses": [{"type": "tiles",
"status": "queued"
}
],
"info": {"description": "./ortho-dem.tif",
"driverShortName": "GTiff",
"driverLongName": "GeoTIFF",
"files": ["./ortho-dem.tif"
],
"size": [[4289,
5612
]
],
"coordinateSystem": {"wkt": "string",
"dataAxisToSRSAxisMapping": [[2,
1
]
]
},
"geoTransform": [[140.43392886025845,
0.0000013227283488,
0,
35.84971998769358,
0,
-0.0000010769339717
]
],
"metadata": { },
"cornerCoordinates": {"upperLeft": [[140.4339289,
35.84972
]
],
"lowerLeft": [[140.4339289,
35.8436762
]
],
"lowerRight": [0
],
"upperRight": [[140.439602,
35.84972
]
],
"center": [[140.4367655,
35.8466981
]
]
},
"wgs84Extent": {"type": "Polygon",
"coordinates": [[0
]
]
},
"bands": [{"band": 1,
"block": [[256,
256
]
],
"type": "Float32",
"colorInterpretation": "Gray",
"noDataValue": -32767,
"overviews": [{"size": [0
]
}
],
"unit": "string",
"metadata": { }
}
]
},
"name": "tokyo",
"description": "test",
"srid": 2451,
"tiles": {"tilesize": 256,
"resampling": "average",
"max_zoom": 10,
"min_zoom": 4,
"tiledriver": "png",
"webp_quality": 75,
"webp_lossless": false
},
"contour": {"band": 1,
"elev_attribute": "elev",
"elev_attribute_min": "elev_min",
"elev_attribute_max": "elev_max",
"3d": false,
"ignore_nodata": false,
"nodata_value": -9999,
"offset": 0,
"layer_name": "contour",
"polygons": false,
"interval": 5
},
"heightmap": {"resolution": 0.1,
"offset": -10000
},
"image": {"format": "png"
}
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetの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.tif",
"content_type": "application/octet-stream"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "test.tif",
"content_type": "application/octet-stream",
"url": "https://dummy.appspot.com/bucket/test.tif?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert Tileset Dataset

Tileset datasetのコンバートを開始します

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Request Body schema: application/json

types

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"types": ["info",
"contour",
"heightmap",
"image",
"tiles"
]
}

List Tileset Dataset Convert Statuses

指定したTileset datasetのコンバート情報のリストを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

TilesetDatasetID

required

string

指定するTilesetDatasetのID。

Responses

Response samples

200

Content type

application/json

[{"id": "2022040459062735",
"userID": "6062859285729275",
"3DDatasetID": "5979479326288593",
"inputFilePath": "https://dummy.appspot.com/tileset/5869839798464838/input",
"outputFilePath": "https://dummy.appspot.com/tileset/5869839798464838/output",
"start_at": "2022-04-04T07:15:32.234156Z",
"finish_at": "2022-04-04T07:15:32.234156Z",
"type": "tiles",
"options": [{"flag": "resampling",
"value": "average"
}
],
"status": "queued"
}
]

Upload 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

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>

Image Datasets V2

Mapray Image API (2.0.0)

Mapray Image API は画像データの管理機能を提供します。

Image Datasetは画像データを意味します。

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

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

エラー一覧

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

List Image Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"url": "https://api.mapray.com/image/4811188005240832/",
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}
]

Create Image Dataset

新しいImage Datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
	Array of objects (ImageFileFormats) ファイル一覧。サポートするフォーマットはPNG画像(.png)、JPEG画像(.jpg/.jpeg)、GIF画像(.gif)、BMP画像(.bmp)です。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"url": "https://api.mapray.com/image/4811188005240832/",
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Count Image Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Image Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"url": "https://api.mapray.com/image/4811188005240832/",
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Update Image Dataset

Image Datasetのプロパティを更新します。 request bodyで指定したImage Datasetオブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"url": "https://api.mapray.com/image/4811188005240832/",
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Delete Image Dataset

指定したImage Datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset Image Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
	Array of objects (ImageFileFormats) ファイル一覧。サポートするフォーマットはPNG画像(.png)、JPEG画像(.jpg/.jpeg)、GIF画像(.gif)、BMP画像(.bmp)です。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "tokyo",
"description": "test",
"files": [{"name": "image.jpg",
"format": "jpg"
},
{"name": "icon.png",
"format": "png"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"url": "https://api.mapray.com/image/4811188005240832/",
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage 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": "image.jpg",
"content_type": "image/jpeg"
},
{"filename": "icon.png",
"content_type": "image/png"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "image.jpg",
"content_type": "image/jpeg",
"url": "https://storage.googleapis.com/inou-dev.appspot.com/bucket/image.jpg?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
},
{"filename": "icon.png",
"content_type": "image/png",
"url": "https://storage.googleapis.com/inou-dev.appspot.com/bucket/icon.png?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert Image Dataset

Image Datasetのコンバートを開始します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Responses

Retrieve Image Dataset Convert Status

指定したImage Datasetのコンバート情報を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

imagedatasetID

required

string

指定するImage DatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005240832",
"jobType": "",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/imagedataset/4098494030324145/4811188005240832/input",
"outputFilePath": "dummy.appspot.com/imagedataset/4098494030324145/4811188005240832/output",
"options": null,
"error": "",
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:15Z",
"status": "ready"
}

Upload 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

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>

Vectile Datasets V2

Mapray Vectile Dataset API (2.0.0)

Mapray Vectile Dataset APIは３次元地理空間のベクトルタイルデータの管理機能を提供します。

Vectile Datasetは3次元のベクトルタイルデータを意味します。

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

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

エラー一覧

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

List Vectile Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "5078911457165312",
"owner_id": "6232715078664192",
"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"url": "https://dummy.com/vectile/5078911457165312/mvt/",
"files": [{"name": "vectile.json",
"format": "json"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
},
{"id": "4825312963201189",
"owner_id": "6232715078664192",
"name": "ikebukuro_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 8,
"max_zoom": 20,
"url": "https://dummy.com/vectile/4825312963201189/mvt/",
"files": [{"name": "vectile.json",
"format": "json"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"created_at": "2017-11-23T02:13:07Z",
"updated_at": "2018-01-05T05:32:46Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}
]

Create Vectile Dataset

新しいVectile Datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
src_file_type required	string Enum: "geojson" "kml" コンバート前のデータフォーマット。
	Array of objects (VectileFileFormats) ファイル一覧。サポートするフォーマットはGeoJSON(.geojson)、KML(.kml)です。
layer_name	string <= 100 characters データを読み込むレイヤーの名前。
min_zoom	number [ 0 .. 20 ] Default: 0 最小ズームレベル。
max_zoom	number or null Default: null 最大ズームレベル。 nullの場合は妥当な最大ズームレベルを推測します。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"src_file_type": "geojson",
"files": [{"name": "vectile.geojson",
"format": "geojson"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "https://dummy.com/vectile/4811188005240832/mvt/",
"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"files": [{"name": "vectile.json",
"format": "json"
}
],
"status": "",
"error": "",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false,
"public_url": ""
}

Count Vectile Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Vectile Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "https://dummy.com/vectile/4811188005240832/mvt/",
"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"files": [{"name": "vectile.json",
"format": "json"
}
],
"status": "ready",
"error": "",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false,
"public_url": ""
}

Update Vectile Dataset

Vectile Datasetのプロパティを更新します。 request bodyで指定したVectile Datasetオブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "example",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "https://dummy.com/vectile/4811188005240832/mvt/",
"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"files": [{"name": "vectile.json",
"format": "json"
}
],
"status": "ready",
"error": "",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false,
"public_url": ""
}

Delete Vectile Dataset

指定したVectile Datasetを削除します。アップロードしたデータ全てを削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset Vectile Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
src_file_type required	string Enum: "geojson" "kml" コンバート前のデータフォーマット。
	Array of objects (VectileFileFormats) ファイル一覧。サポートするフォーマットはGeoJSON(.geojson)、KML(.kml)です。
layer_name	string <= 100 characters データを読み込むレイヤーの名前。
min_zoom	number [ 0 .. 20 ] Default: 0 最小ズームレベル。
max_zoom	number or null Default: null 最大ズームレベル。 nullの場合は妥当な最大ズームレベルを推測します。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"src_file_type": "geojson",
"files": [{"name": "vectile.geojson",
"format": "geojson"
}
],
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "https://dummy.com/vectile/4811188005240832/mvt/",
"name": "shinagawa_area",
"description": "example",
"layer_name": "layer",
"min_zoom": 4,
"max_zoom": 10,
"files": [{"name": "vectile.json",
"format": "json"
}
],
"status": "",
"error": "",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false,
"public_url": ""
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile 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": "vectile.json",
"content_type": "application/geo+json"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "vectile.json",
"content_type": "application/geo+json",
"url": "https://storage.googleapis.com/bucket/vectile.json?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert Vectile Dataset

Vectile Datasetのコンバートを開始します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Retrieve Vectile Dataset Convert Status

指定したVectile Datasetのコンバート情報を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005240832",
"jobType": "",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/vectiledataset/4098494030324145/4811188005240832/input",
"outputFilePath": "dummy.appspot.com/vectiledataset/4098494030324145/4811188005240832/output",
"options": [{"flag": "maximum-zoom",
"value": "g"
},
{"flag": "minimum-zoom",
"value": "0"
}
],
"error": "",
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:15Z",
"status": "ready"
}

Upload 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

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>

DEM Datasets V2

Mapray DEM Dataset API (2.0.0)

Mapray DEM Dataset APIは地図形状タイルの管理機能を提供します。

DEM Datasetは地図形状タイルデータを意味します。

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

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

エラー一覧

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

List DEM Datasets

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

Authorizations:

Api-KeyOrganization-Token

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": 4811188005240832,
"owner_id": 4098494030324145,
"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srcformat": "geotiff",
"format": "dem",
"url": "https://api.mapray.com/demdataset/4811188005240832/",
"fileinfo": {"bbox": [123.4,
56.7
]
},
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}
]

Create DEM Dataset

新しい DEM Dataset を作成します。

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
src_file_type	string Default: "geotiff" コンバート前のデータフォーマット。
dst_file_type	string Default: "dem" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"src_file_type": "geotiff",
"dst_file_type": "dem"
}

Response samples

200

Content type

application/json

{"id": 4811188005240832,
"owner_id": 4098494030324145,
"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srcformat": "geotiff",
"format": "dem",
"url": "https://api.mapray.com/demdataset/4811188005240832/",
"fileinfo": null,
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Count DEM Datasets

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

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve DEM Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Responses

Response samples

200

Content type

application/json

{"id": 4811188005240832,
"owner_id": 4098494030324145,
"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srcformat": "geotiff",
"format": "dem",
"url": "https://api.mapray.com/demdataset/4811188005240832/",
"fileinfo": {"bbox": [123.4,
56.7
]
},
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Update DEM Dataset

DEM Dataset のプロパティを更新します。 request bodyで指定した DEM Dataset オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "tokyo",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false
}

Response samples

200

Content type

application/json

{"id": 4811188005240832,
"owner_id": 4098494030324145,
"name": "tokyo",
"description": "tokyo",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srcformat": "geotiff",
"format": "dem",
"url": "https://api.mapray.com/demdataset/4811188005240832/",
"fileinfo": {"bbox": [123.4,
56.7
]
},
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-10T00:00:00.871648747Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Delete DEM Dataset

指定した DEM Dataset を削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Responses

Response samples

200

Content type

application/json

{ }

Reset DEM Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
src_file_type	string Default: "geotiff" コンバート前のデータフォーマット。
dst_file_type	string Default: "dem" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"src_file_type": "geotiff",
"dst_file_type": "dem"
}

Response samples

200

Content type

application/json

{"id": 4811188005240832,
"owner_id": 4098494030324145,
"name": "tokyo",
"description": "tokyo area",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srcformat": "geotiff",
"format": "dem",
"url": "https://api.mapray.com/demdataset/4811188005240832/",
"fileinfo": null,
"created_at": "2023-01-01T00:00:00.871648747Z",
"updated_at": "2023-01-05T00:00:00.871648747Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM 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": "tokyo.tif",
"content_type": "application/gml+xml"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "tokyo.tif",
"context_type": "application/gml+xml",
"url": "https://storage.googleapis.com/bucket/tokyo.tif?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert DEM Dataset

DEM Dataset のコンバートを開始します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Responses

Retrieve DEM Dataset Convert Status

指定した DEM Dataset のコンバート情報を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

DEMDatasetID

required

string

指定する DEM Dataset の ID。

Responses

Response samples

200

Content type

application/json

{"id": 6833388005240832,
"userID": 4098494030324145,
"3DDatasetID": 4811188005240832,
"inputFilePath": "dummy.appspot.com/demdataset/4098494030324145/4811188005240832/input",
"outputFilePath": "dummy.appspot.com/demdataset/4098494030324145/4811188005240832/output",
"options": null,
"startAt": "2023-01-05T00:00:00.871648747Z",
"finishAt": "2023-01-05T00:00:00.871648747Z",
"status": "ready",
"error": ""
}

Upload 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

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>

Scene V2

Mapray Scene API

シーンの作成、取得、更新、削除及びシーンエンティティの追加、取得、更新、削除を行うAPIです。

エラー一覧

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

Get Scene

所属組織に紐づくシーンを全て取得する

Authorizations:

Api-KeyOrganization-Token

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": "4321567809871234",
"owner_id": "1234567890123456",
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-05 00:00:00",
"name": "scene1",
"description": "test",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"entity_3d_id": [1234567890123456,
9876543210654320
]
},
{"id": "9876543210987654",
"owner_id": "1234567890123456",
"created_at": "2021-01-01 01:00:00",
"updated_at": "2021-01-01 01:00:00",
"name": "scene2",
"description": "",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"entity_3d_id": [1234567890123456,
9876543210654320
]
}
]

Create Scene

新しいシーンを作成する

Authorizations:

Api-KeyOrganization-Token

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters シーン名
description	string [ 0 .. 300 ] characters 説明
x	number Default: 0 x座標
y	number Default: 0 y座標
z	number Default: 0 z座標

Responses

Request samples

Payload

Content type

application/json

{"name": "scene1",
"description": "test",
"x": 1.1,
"y": 2.2,
"z": 3.3
}

Response samples

200

Content type

application/json

{"id": "string",
"owner_id": "string",
"created_at": "string",
"updated_at": "string",
"entity_3d_id": [0
],
"name": "string",
"description": "string",
"x": 0,
"y": 0,
"z": 0
}

Count Scene

所属組織に紐づくシーンの数を取得する

Authorizations:

Api-KeyOrganization-Token

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Scene

指定したシーンの情報を取得する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Responses

Response samples

200

Content type

application/json

{"id": "24321567809871234",
"owner_id": "1234567890123456",
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00",
"name": "scene1",
"description": "test",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"entity_3d_id": [1234567890123456,
9876543210654320
]
}

Update Scene

指定したシーン情報を更新する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters シーン名
description	string [ 0 .. 300 ] characters 説明
x	number Default: 0 x座標
y	number Default: 0 y座標
z	number Default: 0 z座標

Responses

Request samples

Payload

Content type

application/json

{"name": "scene1",
"description": "test",
"x": 1.1,
"y": 2.2,
"z": 3.3
}

Response samples

200

Content type

application/json

{"id": "4321567809871234",
"owner_id": "1234567890123456",
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-05 00:00:00",
"name": "scene1",
"description": "test",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"entity_3d_id": [1234567890123456,
9876543210654320
]
}

Delete Scene

指定したシーンを削除する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Responses

Response samples

200

Content type

application/json

{ }

Retrieve Mapray SceneFile Dataset

指定したシーンのmapray sceneフォーマットのJSONを取得する。

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Responses

Response samples

200

Content type

application/json

{"id": "1111111122222222",
"scene_file": {"model_register": {"1111222233334444": {"link": "https://inou-test.appspot.com/3ddatasets/v2/models/1234567812345678/1111222233334444/model.gltf",
"offset_transform": {"heading": 0,
"tilt": 0,
"scale": 1
}
}
},
"entity_list": [{"id": "1122334455667788",
"type": "model",
"transform": {"position": [1,
1,
1
],
"heading": 0,
"tilt": 0,
"roll": 0,
"scale": [1,
1,
1
]
},
"ref_model": "1111222233334444",
"index": "0"
}
]
}
}

Get SceneEntity 3dDatasets

指定したシーンに紐づく3Dエンティティ情報を全て取得する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

query Parameters

page	integer >= 1 Default: 1 1ページの要素数がlimitの場合のページ番号。
limit	integer [ 1 .. 100 ] Default: 5 1ページの要素数。
sort	string Default: "updatedAt" Enum: "3ddataset_id" "name" "updatedAt" ソートを行うプロパティ。
direction	string Default: "desc" Enum: "asc" "desc" ソート方向。

Responses

Response samples

200

Content type

application/json

[{"id": "1234567890123456",
"scene_id": "6543210987654321",
"3ddataset_id": "4321567809871234",
"owner_id": "88776655443322",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 01:00:00",
"updated_at": "2021-01-05 01:00:00"
},
{"id": "1111222233334444",
"scene_id": "6543210987654321",
"3ddataset_id": "9988776655443322",
"owner_id": "8877665544332211",
"name": "scenedata2",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00"
}
]

Add SceneEntity 3dDataset

指定したシーンの3Dエンティティを追加する(複数エンティティ追加可)

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Request Body schema: application/json
required

Array

3ddataset_id required	string 3ddatasetID
name required	string [ 1 .. 128 ] characters シーンエンティティ名
x	number Default: 0 x座標
y	number Default: 0 y座標
z	number Default: 0 z座標
roll	number Default: 0 x軸の回転
tilt	number Default: 0 y軸の回転
heading	number Default: 0 z軸の回転
sx	number Default: 1 x軸の縮尺
sy	number Default: 1 y軸の縮尺
sz	number Default: 1 z軸の縮尺

Responses

Request samples

Payload

Content type

application/json

[{"3ddataset_id": "4321567809871234",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3
},
{"3ddataset_id": "1122334455667788",
"name": "scenedata2",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3
}
]

Response samples

200

Content type

application/json

[{"id": "1234567890123456",
"scene_id": "6543210987654321",
"3ddataset_id": "4321567809871234",
"owner_id": "8877665544332211",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00"
},
{"id": "1234567890123456",
"scene_id": "6543210987654321",
"3ddataset_id": "1122334455667788",
"owner_id": "8877665544332211",
"name": "scenedata2",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-01 00:00:00"
}
]

Update SceneEntity 3dDataset

指定したシーンの3Dエンティティを更新する(複数エンティティ更新可)

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid

required

string

シーンID。

Request Body schema: application/json
required

Array

id required	string シーンエンティティID
name required	string [ 1 .. 128 ] characters シーンエンティティ名
x	number Default: 0 x座標
y	number Default: 0 y座標
z	number Default: 0 z座標
roll	number Default: 0 x軸の回転
tilt	number Default: 0 y軸の回転
heading	number Default: 0 z軸の回転
sx	number Default: 1 x軸の縮尺
sy	number Default: 1 y軸の縮尺
sz	number Default: 1 z軸の縮尺

Responses

Request samples

Payload

Content type

application/json

[{"id": "4321567809871234",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3
},
{"id": "1122334455667788",
"name": "scenedata2",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3
}
]

Response samples

200

Content type

application/json

[{"id": "4321567809871234",
"scene_id": "6543210987654321",
"3ddataset_id": "6621567809871234",
"owner_id": "8877665544332211",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-05 00:00:00"
},
{"id": "1122334455667788",
"scene_id": "6543210987654321",
"3ddataset_id": "4321432143214321",
"owner_id": "8877665544332211",
"name": "scenedata2",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 01:00:00",
"updated_at": "2021-01-05 00:00:00"
}
]

Retrieve SceneEntity 3dDataset

指定した3Dエンティティ情報を取得する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid required	string シーンID。
seid required	string シーンエンティティID。

Responses

Response samples

200

Content type

application/json

{"id": "1234567890123456",
"scene_id": "6543210987654321",
"3ddataset_id": "4321567809871234",
"owner_id": "8877665544332211",
"name": "scenedata1",
"x": 1.1,
"y": 2.2,
"z": 3.3,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 1.1,
"sy": 2.2,
"sz": 3.3,
"created_at": "2021-01-01 00:00:00",
"updated_at": "2021-01-05 00:00:00"
}

Delete SceneEntity 3dDataset

指定したシーンの3Dエンティティを削除する

Authorizations:

Api-KeyOrganization-Token

path Parameters

sid required	string シーンID。
seid required	string シーンエンティティID。

Responses

Response samples

200

Content type

application/json

{ }

Vectile

Mapray Vectile API

Mapray Vectile APIは３次元地理空間のベクトルタイルデータの取得機能を提供します。

Vectile は3次元のベクトルタイルデータを意味します。

エラー一覧

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

Get Vector Tiles

対象のベクトルタイルを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID required	string 指定するVectile DatasetのID。
z required	string ズームレベル
x required	string タイル座標のX値
yfile required	string Enum: ".mvt" ".pbf" タイル座標のY値とベクトルタイルの拡張子

Responses

Get Vector Tiles Metadata

対象のベクトルタイルのメタデータを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Response samples

200

Content type

application/json

{"vector_layers": [{"description": "sample_metadata",
"fields": {"Area": "String",
"Style": "String",
"name": "String"
},
"id": "vectile_sample_layer",
"maxzoom": 14,
"minzoom": 0
}
]
}

Create Vector Tiles Style

対象のベクトルタイルのstyle.jsonを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Request Body schema: application/json

name	string ファイル名
style	string style.jsonの中身

Responses

Request samples

Payload

Content type

application/json

{"name": "samplefile.json",
"style": "{\r\n  \"layers\": [\r\n    {\r\n      \"id\": \"id_観光地名称\"\r\n    } \r\n  ]\r\n}"
}

Response samples

200

Content type

application/json

"{\r\n \"layers\": [\r\n {\r\n \"id\": \"id_観光地名称\"\r\n } \r\n ]\r\n}"

Get Vector Tiles Styles

対象のベクトルタイルに紐づくstyle.jsonを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID

required

string

指定するVectile DatasetのID。

Responses

Response samples

200

Content type

application/json

[{"name": "samplefile.json",
"created_at": "2023-09-27T12:58:38.4567890",
"updated_at": "2023-09-28T02:58:27.377537Z"
},
{"name": "samplefile2.json",
"created_at": "2023-09-01T12:34:56.7890123",
"updated_at": "2023-09-12T13:56:27.9461294"
}
]

Retrieve Vector Tiles Style

対象のstyle.jsonを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID required	string 指定するVectile DatasetのID。
filename required	string 指定するファイル名。

Responses

Response samples

200

Content type

application/json

{"layers": [{"id": "id_観光地名称"
}
]
}

Update Vector Tiles Style

対象のstyle.jsonを更新します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID required	string 指定するVectile DatasetのID。
filename required	string 指定するファイル名。

Request Body schema: application/json

更新後のstyle.json

string

Responses

Request samples

Payload

Content type

application/json

{"layers": [{"id": "id_観光地名称"
}
]
}

Response samples

200

Content type

application/json

{"layers": [{"id": "id_観光地名称"
}
]
}

Delete Vector Tiles Style

対象のstyle.jsonを削除します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID required	string 指定するVectile DatasetのID。
filename required	string 指定するファイル名。

Responses

Response samples

200

Content type

application/json

{ }

Rename Vector Tiles Style

style.jsonの名前を変更します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

VectileDatasetID required	string 指定するVectile DatasetのID。
filename required	string 指定するファイル名。

Request Body schema: application/json

名前変更後のファイル名

name	string 変更後のファイル名

Responses

Request samples

Payload

Content type

application/json

{"name": "sample20230929.json"
}

Response samples

200

Content type

application/json

{ }

Organization

組織を管理するAPIです。

Get Organization

ユーザーの所属している組織リストを取得する。

Authorizations:

User-Token

query Parameters

page	integer >= 1 Default: 1 1ページの要素数がlimitの場合のページ番号。
limit	integer [ 1 .. 100 ] Default: 5 1ページの要素数。
sort	string Default: "invitedAt" Enum: "id" "invitedAt" ソートを行うプロパティ。
direction	string Default: "desc" Enum: "asc" "desc" ソート方向。

Responses

Response samples

200
400
403
404

Content type

application/json

[{"id": 4321567809871234,
"name": "org01",
"is_default": true,
"created_at": "2021-01-01 20:21:11",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback"
],
"role": "admin"
},
{"id": 1234567890123456,
"name": "org02",
"is_default": false,
"created_at": "2021-01-01 20:21:12",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback"
],
"role": "admin"
},
{"id": 9876543210987654,
"name": "org03",
"is_default": false,
"created_at": "2021-01-01 20:21:13",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback"
],
"role": "admin"
}
]

Create Organization

新しい組織を作成する。

Authorizations:

User-Token

Request Body schema: application/json

name required	string 組織名
redirect_uri	Array of strings 認証後にリダイレクトするURL

Responses

Request samples

Payload

Content type

application/json

{"name": "org4",
"redirect_uri": ["https://client.com/callback"
]
}

Response samples

200
400
403

Content type

application/json

{"id": 4321432143214321,
"name": "org4",
"is_default": false,
"created_at": "2021-01-01 20:21:14",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback"
]
}

Retrieve Organization

特定の組織情報を取得する。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid

required

string

対象組織ID

Responses

Response samples

200
400
403
404

Content type

application/json

{"id": 4321567809871234,
"name": "org01",
"is_default": true,
"created_at": "2021-01-01 20:21:11",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback"
]
}

Update Organization

組織の名前、リダイレクトURLを変更する。

条件

招待を受諾している
adminである
ユーザーに紐づいた組織でない

Authorizations:

User-Token

path Parameters

oid

required

string

対象組織ID

Request Body schema: application/json

name required	string 組織名
redirect_uri	Array of strings 認証後にリダイレクトするURL

Responses

Request samples

Payload

Content type

application/json

{"name": "org1-update",
"redirect_uri": ["https://client.com/callback/update"
]
}

Response samples

200
400
403
404

Content type

application/json

{"id": 4321432143214321,
"name": "org1-update",
"is_default": false,
"created_at": "2021-01-01 20:21:14",
"token": "abcdefghijklmnopqrstuvwxyzABCD0123456789",
"redirect_uri": ["https://client.com/callback/update"
]
}

Delete Organization

組織に関する全情報を削除する。(組織、所属ユーザー、データセット、APIKey、AccessToken)

条件

招待を受諾している
adminである
ユーザーに紐づいた組織でない

Authorizations:

User-Token

path Parameters

oid

required

string

対象組織ID

Responses

Response samples

200
400
403
404

Content type

application/json

{ }

List Organization Member

特定の組織に所属しているユーザーのリストを取得する。

Authorizations:

Organization-Token

query Parameters

page	integer >= 1 Default: 1 1ページの要素数がlimitの場合のページ番号。
limit	integer [ 1 .. 100 ] Default: 5 1ページの要素数。
sort	string Default: "invitedAt" Enum: "id" "invitedAt" ソートを行うプロパティ。
direction	string Default: "desc" Enum: "asc" "desc" ソート方向。

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uid": "1234567890098765",
"role": "admin",
"verified": true,
"invited_at": "2021-01-01 20:23:11",
"name": "user01",
"invitation_id": "0"
}
]

Invite Organization Member

組織にユーザーを招待する。

条件

ユーザーに紐づいた組織でない。
組織に参加しているユーザーでない。

Authorizations:

Organization-Token

Request Body schema: application/json

role required	string Enum: "admin" "user" 組織内の役割。
user_id required	string 招待するユーザーのID。

Responses

Request samples

Payload

Content type

application/json

{"role": "admin",
"user_id": "1234567890123456"
}

Response samples

200
400
403
404

Content type

application/json

{ }

Update Organization Member

所属ユーザーの役割を変更する。

条件

招待を受諾している。
ユーザーに紐づいた組織でない。
adminが組織に一人しかいない場合、adminは自身の役割を変更できない。

Authorizations:

Organization-Token

path Parameters

uid

required

string

対象ユーザーID

Request Body schema: application/json

role

required

string

Enum: "admin" "user"

組織内の役割。

Responses

Request samples

Payload

Content type

application/json

{"role": "user"
}

Response samples

200
400
403
404

Content type

application/json

{"uid": "1234567890098765",
"role": "user",
"verified": true,
"invited_at": "2021-01-01 20:23:11",
"name": "user01",
"invitation_id": "0"
}

Leave Organization Member

組織から脱退する。

条件

招待を受諾している。
ユーザーに紐づいた組織でない。
adminが組織に一人しかいない場合、adminは脱退できない。

Authorizations:

Organization-Token

path Parameters

uid

required

string

対象ユーザーID

Responses

Response samples

200
400
403
404

Content type

application/json

{ }

Organization Token

Organization token API は Organization、Dataset、Token のアクセストークンを作成、取得、更新、削除する API です。

List Organization tokens

対象組織IDに紐づくすべてのOrganization tokenを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid

required

string

対象組織ID

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": 1234567890123456,
"oid": 9876543210987654,
"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
},
{"id": 1122334455667788,
"oid": 9876543210987654,
"name": "token2",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read",
"dataset:create",
"dataset:update",
"dataset:delete"
],
"allowedDomains": ["mapray.com",
"mapray2.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}
]

Create Organization token

新しいOrganization tokenを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid

required

string

対象組織ID

Request Body schema: application/json

name required	string [ 2 .. 128 ] characters 名前
access_ip required	Array of strings アクセスを許可するIPアドレスの一覧 CIDR表記
scopes required	Array of strings Items Enum: "dataset:read" "dataset:create" "dataset:update" "dataset:delete" "token:read" "token:create" "token:update" "token:delete" "member:read" "member:create" "member:update" "member:delete" "organization:read" 付与する権限の一覧
allowedDomains	Array of strings アクセスを許可するドメインのリストです。ドメイン名、または「localhost:ポート番号」が指定できます。指定しない場合はすべてのドメインのアクセスを許可します。

Responses

Request samples

Payload

Content type

application/json

{"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
]
}

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"oid": 9876543210987654,
"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
],
"token": "abcdefghIJKLMNOPQRSTUvwxyz12345678901234",
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Retrieve Organization token

対象組織IDに紐づく一意のOrganization tokenを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid required	string 対象組織ID
tid required	string トークンID

Responses

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"oid": 9876543210987654,
"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Update Organization token

対象組織IDに紐づく一意のOrganization tokenを更新します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid required	string 対象組織ID
tid required	string トークンID

Request Body schema: application/json

name required	string [ 2 .. 128 ] characters 名前
access_ip required	Array of strings アクセスを許可するIPアドレスの一覧 CIDR表記
scopes required	Array of strings Items Enum: "dataset:read" "dataset:create" "dataset:update" "dataset:delete" "token:read" "token:create" "token:update" "token:delete" "member:read" "member:create" "member:update" "member:delete" "organization:read" 付与する権限の一覧
allowedDomains	Array of strings アクセスを許可するドメインのリストです。ドメイン名、または「localhost:ポート番号」が指定できます。指定しない場合はすべてのドメインのアクセスを許可します。

Responses

Request samples

Payload

Content type

application/json

{"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
]
}

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"oid": 9876543210987654,
"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["dataset:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Delete Organization token

対象組織IDに紐づく一意のOrganization tokenを削除します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

oid required	string 対象組織ID
tid required	string トークンID

Responses

Response samples

200

Content type

application/json

{ }

User

User API はユーザーのアカウント情報を取得する API です。

Get Account Profile

認証情報から得たユーザーIDに紐づくアカウント情報を取得します。

Authorizations:

User-Token

Responses

Response samples

200

Content type

application/json

{"id": "1234567890123456",
"email": "test@test.co.jp",
"name": "test1",
"createdAt": "2024-01-01T00:00:00",
"updatedAt": "2024-01-01T00:00:00"
}

User Token

User token API は User、Organization のアクセストークンを作成、取得、更新、削除する API です。

List User tokens

ユーザーIDに紐づくすべてのUser tokenを取得します。

Authorizations:

User-Token

path Parameters

uid

required

string

ユーザーID

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": 1234567890123456,
"name": "token1",
"uid": 9876543210987654,
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
},
{"id": 1122334455667788,
"name": "token2",
"uid": 9876543210987654,
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read",
"organization:create",
"organization:update",
"organization:delete"
],
"allowedDomains": ["mapray.com",
"mapray2.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}
]

Create User token

新しいUser tokenを作成します。

Authorizations:

User-Token

path Parameters

uid

required

string

ユーザーID

Request Body schema: application/json

name required	string [ 2 .. 128 ] characters 名前
access_ip required	Array of strings アクセスを許可するIPアドレスの一覧 CIDR表記
scopes required	Array of strings Items Enum: "organization:read" "organization:create" "organization:update" "organization:delete" "token:read" "token:create" "token:update" "token:delete" "user:read" 付与する権限の一覧
allowedDomains	Array of strings アクセスを許可するドメインのリストです。ドメイン名、または「localhost:ポート番号」が指定できます。指定しない場合はすべてのドメインのアクセスを許可します。

Responses

Request samples

Payload

Content type

application/json

{"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
]
}

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"name": "token1",
"uid": 9876543210987654,
"token": "abcdefghIJKLMNOPQRSTUvwxyz12345678901234",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Retrieve User token

ユーザーIDに紐づく一意のUser tokenを取得します。

Authorizations:

User-Token

path Parameters

uid required	string ユーザーID
tid required	string トークンID

Responses

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"name": "token1",
"uid": 9876543210987654,
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Update User token

ユーザーIDに紐づく一意のUser tokenを更新します。

Authorizations:

User-Token

path Parameters

uid required	string ユーザーID
tid required	string トークンID

Request Body schema: application/json

name required	string [ 2 .. 128 ] characters 名前
access_ip required	Array of strings アクセスを許可するIPアドレスの一覧 CIDR表記
scopes required	Array of strings Items Enum: "organization:read" "organization:create" "organization:update" "organization:delete" "token:read" "token:create" "token:update" "token:delete" "user:read" 付与する権限の一覧
allowedDomains	Array of strings アクセスを許可するドメインのリストです。ドメイン名、または「localhost:ポート番号」が指定できます。指定しない場合はすべてのドメインのアクセスを許可します。

Responses

Request samples

Payload

Content type

application/json

{"name": "token1",
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
]
}

Response samples

200

Content type

application/json

{"id": 1234567890123456,
"name": "token1",
"uid": 9876543210987654,
"access_ip": ["192.168.10.0/24",
"192.168.20.0/24"
],
"scopes": ["organization:read"
],
"allowedDomains": ["mapray.com"
],
"created_at": "2021-01-01T01:01:01.0000001Z",
"updated_at": "2021-01-01T01:01:01.0000001Z"
}

Delete User token

ユーザーIDに紐づく一意のUser tokenを削除します。

Authorizations:

User-Token

path Parameters

uid required	string ユーザーID
tid required	string トークンID

Responses

Response samples

200

Content type

application/json

{ }

Weather

Mapray Weather API 天気情報のラスター地理空間情報データを提供します。

天気情報一覧

Layer name	データソース	説明	取得間隔	予報間隔
cloudcover	https://registry.opendata.aws/noaa-gfs-bdp-pds/	全世界の雲量データ	6時間毎	3時間おき336時間後まで

エラー一覧

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

Show layer info

対象天気情報の詳細を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

layer

required

string

対象とする天気情報のキー

Responses

Response samples

200

Content type

application/json

[{"minZoom": "0",
"maxZoom": "0",
"format": "png",
"dataList": [{"time": 1675182430,
"forecasts": [1675183430,
1675184430,
1675185430,
1675186430,
1675187430,
1675188430,
1675189430
]
},
{"time": 1675082430,
"forecasts": [1675083430,
1675084430,
1675085430,
1675086430,
1675087430,
1675088430,
1675089430
]
}
]
}
]

Get weather tile

対象天気情報のタイルを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

layer required	string 対象とする天気情報のキー
time required	integer 時刻
z required	integer ズームレベル
x required	integer x座標
y required	integer y座標
format required	string タイルのフォーマット

Responses

2D Datasets V1

Mapray Dataset API (1.0.0)

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

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

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

エラー一覧

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

List Datasets

userIDに紐づくdatasetリストを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

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" ソート方向。
name	string 検索を行う名前。

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

datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

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

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (2DSrid) Default: 4326 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	string Default: "EGM96_15" Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル。
src_file_type	string Default: "geojson" Enum: "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット。
dst_file_type	string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット。

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

userIDに紐づくdatasetの数を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザー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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (2DSrid) Default: 4326 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	string Default: "EGM96_15" Enum: "EGM96_15" "JGD2011" "ELLIPSOID" 使用しているジオイドモデル。
src_file_type	string Default: "geojson" Enum: "geojson" "kml" "gpx" "shp" コンバート前のデータフォーマット。
dst_file_type	string Default: "geojson" Value: "geojson" コンバート後のデータフォーマット。

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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
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
400

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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetのID。

Responses

Response samples

200

Content type

application/json

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

List Features

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetの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"
}
},
{"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"
}
}
]
}
]

Insert Feature

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定する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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定する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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
maprayFeatureID required	string 指定するfeatureの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": "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

指定したfeatureを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザー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:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
maprayFeatureID required	string 指定するfeatureのID。

Responses

Response samples

200

Content type

application/json

{ }

Convert 2D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
datasetID required	string 指定するdatasetのID。

Responses

Retrieve 2D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
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"
}

Upload 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

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>

3D Datasets V1

Mapray 3D Dataset API (1.0.0)

Mapray 3D Dataset API は３次元地理空間情報データの管理機能を提供します。

3D datasetは3次元データを意味しており、3D datasetオブジェクトはmaprayJSで利用されるmaprayシーンファイルに相当します。

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

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

エラー一覧

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

List 3D Datasets

userIDに紐づく3D datasetリストを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v1/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}
]

Create 3D Dataset

新しい3D datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

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

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
altitude_mode	string Default: "absolute" Enum: "absolute" "relative" "clamp" sridで指定した座標系で高度の基準。
src_file_type required	string Enum: "glTF" "obj" コンバート前のデータフォーマット。
dst_file_type	string Default: "glTF" コンバート後のデータフォーマット。
path	string 関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない。
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"src_file_type": "glTF",
"dst_file_type": "glTF",
"scene_id": "0",
"srid": 4326,
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"url": "3ddatasets/v1/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Count 3D Datasets

userIDに紐づく3D datasetの数を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v1/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Update 3D Dataset

3D datasetのプロパティを更新します。 request bodyで指定した3D datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"scene_id": "0",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"url": "3ddatasets/v1/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Delete 3D Dataset

指定した3D datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
altitude_mode	string Default: "absolute" Enum: "absolute" "relative" "clamp" sridで指定した座標系で高度の基準。
src_file_type required	string Enum: "glTF" "obj" コンバート前のデータフォーマット。
dst_file_type	string Default: "glTF" コンバート後のデータフォーマット。
path	string 関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない。
scene_id	string Default: "0" デフォルトで有効にしたいシーンID。glTFの場合は0以上の整数を文字列にしたもの。
x	number Default: 0 sridで指定した座標系での位置 x。(座標系の定義による)
y	number Default: 0 sridで指定した座標系での位置 y。(座標系の定義による)
z	number Default: 0 sridで指定した座標系での位置 z。(座標系の定義による)
roll	number Default: 0 sridで指定した座標系でのx軸の回転。
tilt	number Default: 0 sridで指定した座標系でのy軸の回転。
heading	number Default: 0 sridで指定した座標系でのz軸の回転。
sx	number Default: 1 sridで指定した座標系でのx軸の縮尺比率。
sy	number Default: 1 sridで指定した座標系でのy軸の縮尺比率。
sz	number Default: 1 sridで指定した座標系でのz軸の縮尺比率。
offset_x	number Default: 0 sridで指定した座標系でのoffset位置 x。
offset_y	number Default: 0 sridで指定した座標系でのoffset位置 y。
offset_z	number Default: 0 sridで指定した座標系でのoffset位置 z。
offset_roll	number Default: 0 sridで指定した座標系でoffset位置でのx軸の回転。
offset_tilt	number Default: 0 sridで指定した座標系でoffset位置でのy軸の回転。
offset_heading	number Default: 0 sridで指定した座標系でoffset位置でのz軸の回転。
offset_sx	number Default: 1 sridで指定した座標系でoffset位置でのx軸の縮尺比率。
offset_sy	number Default: 1 sridで指定した座標系でoffset位置でのy軸の縮尺比率。
offset_sz	number Default: 1 sridで指定した座標系でoffset位置でのz軸の縮尺比率。
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"src_file_type": "glTF",
"dst_file_type": "glTF",
"scene_id": "0",
"srid": 4326,
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"url": "3ddatasets/v1/models/4098494030324145/4811188005240832/small.gltf",
"name": "shinagawa_area",
"description": "test",
"path": "/small.gltf",
"format": "glTF",
"scene_id": "0",
"srid": 4326,
"status": "ready",
"x": 123.456789,
"y": 34.5678901,
"z": 123.456,
"roll": 1.1,
"tilt": 2.2,
"heading": 3.3,
"sx": 4.4,
"sy": 5.5,
"sz": 6.6,
"offset_x": 7.7,
"offset_y": 8.8,
"offset_z": 9.9,
"offset_roll": 10,
"offset_tilt": 11.1,
"offset_heading": 22.2,
"offset_sx": 33.3,
"offset_sy": 44.4,
"offset_sz": 55.5,
"altitude_mode": "absolute",
"extensions": {"shadeless": true
},
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Create Upload URL

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

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

例: sampleディレクトリのファイルをアップロードする場合

  /home
  └── user
      └── sample
          ├── test.gltf
          └── texture
              └── test.png

ファイルフォーマットごとに注意点がありますが、例えばglTFファイルはglTFにリンクされるbinファイル、テクスチャファイルへのパスが記述されますが、これらのパスはglTF本体からの相対パスが指定されている必要があります。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3Ddatasetの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.glTF",
"content_type": "model/gltf+json"
},
{"filename": "texture/test.png",
"content_type": "image/png"
}
]

Response samples

200
400

Content type

application/json

[{"filename": "test.glTF",
"content_type": "model/gltf+json",
"url": "https://storage.googleapis.com/bucket/test.glTF?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
},
{"filename": "texture/test.png",
"content_type": "image/png",
"url": "https://storage.googleapis.com/bucket/test.png?Expires=1626000000&GoogleAccessId=upload%40account&Signature=..."
}
]

Convert 3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Responses

Retrieve 3D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005540832",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/3ddataset/4098494030324145/4811188005240832",
"outputFilePath": "dummy.appspot.com/3ddataset/4098494030324145/4811188005240832/output",
"error": "",
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:10Z",
"options": [{"flag": "entity-id",
"value": "5146998000844800"
}
],
"status": "queued"
}

Retrieve Mapray Scene Data

mapray scene フォーマットのJSONを取得する。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

query Parameters

3ddatasets_ids

required

integer

Example: 3ddatasets_ids=5106328150212608,5665678182842368

取得する3DdatasetIDの配列（カンマ区切り、要素数は1以上）

Responses

Response samples

200

Content type

application/json

{"model_register": {"5171376604315648": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5171376604315648/scene.gltf"
},
"5646954843340800": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5646954843340800/scene.gltf"
},
"5665941954232320": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5665941954232320/scene.gltf"
},
"5676392851177472": {"link": "https://inou-dev.appspot.com/3ddatasets/v1/models/4098494030324145/5676392851177472/scene.gltf"
}
},
"entity_list": [{"type": "model",
"transform": {"position": [130.874242,
33.884403,
2
]
},
"ref_model": "5171376604315648",
"index": 0
},
{"type": "model",
"transform": {"position": [138.712371,
35.506622,
849
]
},
"ref_model": "5646954843340800"
},
{"type": "model",
"transform": {"position": [138.710371,
35.506622,
888
]
},
"ref_model": "5665941954232320",
"index": 0
},
{"type": "model",
"transform": {"position": [138.710371,
35.506622,
2000
]
},
"ref_model": "5676392851177472",
"index": 0
}
]
}

List Blob Files

3ddatasetIDに紐づく全てのblobfileのパスとblobfile IDを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"/main/main.gltf": "5171376604315648",
"/texture/image0.jpg": "5646954843340800",
"/texture/image1.jpg": "5676392851177472"
}

Retrieve Blob File

アップロードしたファイルをダウンロードします。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
3DdatasetID required	string 指定する3DdatasetのID。
path required	string 指定するファイルパス。

Responses

Upload 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

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>

PC Datasets V1

Mapray Point Cloud Dataset API (1.0.0)

Mapray Point Cloud Dataset API は３次元地理空間の点群データの管理機能を提供します。

PC Datasetは3次元の点群データを意味します。

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

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

エラー一覧

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

List PC Datasets

userIDに紐づくPC datasetリストを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}
]

Create PC Dataset

新しいPC datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type required	string Enum: "e57" "las" "laz" "ply" "pts" "ptx" "xyz" コンバート前のデータフォーマット。
dst_file_type	string Default: "raw" Value: "raw" コンバート後のデータフォーマット。
	object ローカル座標の原点。（sridを指定しない場合に必要）
	object 点群の回転。（sridを指定しない場合に必要）
scale	number Default: 1 点群のスケール。（sridを指定しない場合に必要）
xyz_type	integer [ 1 .. 8 ] xyzフォーマットの種類番号。入力ファイルがxyz形式の場合に必要。（1:XYZ, 2:XYZRGB, 3:XYZIRGB, 4:XYZI, 5:XYZNxNyNzRGB, 6:XYZNxNyNzIRG, 7:XYZRGBNxNyNz, 8:XYZIRGBNxNyNz）
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"src_file_type": "las",
"dst_file_type": "raw",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-12T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Count PC Datasets

userIDに紐づくPC datasetの数を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Update PC Dataset

PC datasetのプロパティを更新します。 request bodyで指定したPC datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-18T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Delete PC Dataset

指定したPC datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type required	string Enum: "e57" "las" "laz" "ply" "pts" "ptx" "xyz" コンバート前のデータフォーマット。
dst_file_type	string Default: "raw" Value: "raw" コンバート後のデータフォーマット。
	object ローカル座標の原点。（sridを指定しない場合に必要）
	object 点群の回転。（sridを指定しない場合に必要）
scale	number Default: 1 点群のスケール。（sridを指定しない場合に必要）
xyz_type	integer [ 1 .. 8 ] xyzフォーマットの種類番号。入力ファイルがxyz形式の場合に必要。（1:XYZ, 2:XYZRGB, 3:XYZIRGB, 4:XYZI, 5:XYZNxNyNzRGB, 6:XYZNxNyNzIRG, 7:XYZRGBNxNyNz, 8:XYZIRGBNxNyNz）
	object keyがコンバートオプションのMap。

Responses

Request samples

Payload

Content type

application/json

{"name": "tokyo",
"description": "test",
"srid": 2451,
"src_file_type": "las",
"dst_file_type": "raw",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Response samples

200

Content type

application/json

{"id": "5698378922983424",
"owner_id": "6252052887896064",
"created_at": "2021-08-12T02:58:27.377537Z",
"updated_at": "2021-08-12T02:58:27.377537Z",
"url": "https://dummy.appspot.com/pc/5698378922983424/",
"format": "raw",
"name": "tokyo",
"description": "test",
"srid": 2451,
"status": "ready",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
]
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetの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.las",
"content_type": "application/octet-stream"
}
]

Response samples

200
400

Content type

application/json

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

Convert PC Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Responses

Retrieve PC Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
PCdatasetID required	string 指定するPCdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005540832",
"userID": "6252052887896064",
"3DDatasetID": "6252052887896064",
"inputFilePath": "dummy.appspot.com/pcdataset/6252052887896064/6252052887896064/input",
"outputFilePath": "dummy.appspot.com/pcdataset/6252052887896064/6252052887896064/output",
"error": "",
"startAt": "2021-08-12T02:58:27.377537Z",
"finishAt": "2021-08-12T02:59:27.377537Z",
"options": [{"flag": "jzone",
"value": "1"
}
],
"status": "ready"
}

Upload 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

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>

B3D Datasets V1

Mapray Building 3D Dataset API (1.0.0)

Mapray Building 3D Dataset API は３次元地理空間の建物3Dデータの管理機能を提供します。

Building 3D Datasetは3次元の建物3Dデータを意味します。

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

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

エラー一覧

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

List B3D Datasets

userIDに紐づくB3D datasetリストを取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

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" ソート方向。
name	string 検索を行う名前。

Responses

Response samples

200

Content type

application/json

[{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}
]

Create B3D Dataset

新しいB3D datasetを作成します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

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

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid required	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "gml" Value: "gml" コンバート前のデータフォーマット。
dst_file_type	string Default: "b3d" Value: "b3d" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"src_file_type": "gml",
"dst_file_type": "b3d"
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Count B3D Datasets

userIDに紐づくB3D datasetの数を取得します。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID

required

string

対象データが紐づいているユーザーID。

Responses

Response samples

200

Content type

application/json

{"count": 0
}

Retrieve B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Update B3D Dataset

B3D datasetのプロパティを更新します。 request bodyで指定したB3D datasets オブジェクトのデータでデータが全て更新されます。（部分更新はできません）

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
is_public	boolean Default: false 公開するかどうかの値。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"is_public": false
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-08T08:12:13Z",
"status": "ready",
"error": "",
"is_public": false,
"public_url": ""
}

Delete B3D Dataset

指定したB3D datasetを削除します。アップロードしたデータ全部を削除します。一度削除したファイルは元に戻すことはできません。

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{ }

Reset B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Request Body schema: application/json

name required	string [ 1 .. 128 ] characters 名前。
description	string [ 0 .. 300 ] characters Default: "" 説明。
	Array of objects (Attributions)
srid required	number (Srid) Enum: 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 4326 空間参照系識別コード(EPSGコード)。http://www.epsg-registry.org/ で示されるコード。
src_file_type	string Default: "gml" Value: "gml" コンバート前のデータフォーマット。
dst_file_type	string Default: "b3d" Value: "b3d" コンバート後のデータフォーマット。

Responses

Request samples

Payload

Content type

application/json

{"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"src_file_type": "gml",
"dst_file_type": "b3d"
}

Response samples

200

Content type

application/json

{"id": "4811188005240832",
"owner_id": "4098494030324145",
"name": "shinagawa_area",
"description": "test",
"attributions": [{"display": "©Mapray",
"link": "https://mapray.com",
"description": "Mapray",
"logo": "https://mapray.com/images/logo.svg"
}
],
"srid": 4326,
"format": "b3d",
"url": "https://dummy.com/b3d/4811188005240832/",
"fileinfo": {"format": 1,
"rho": 7,
"transform": [742.4224066826572,
0,
0
]
},
"created_at": "2017-09-04T05:56:10Z",
"updated_at": "2017-09-04T05:56:10Z",
"status": "",
"error": "",
"is_public": false,
"public_url": ""
}

Create Upload URL

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

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3Ddatasetの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.gml",
"content_type": "application/gml+xml"
}
]

Response samples

200
400

Content type

application/json

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

Convert B3D Dataset

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Responses

Retrieve B3D Dataset Convert Status

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

Authorizations:

Api-KeyOrganization-Token

path Parameters

userID required	string 対象データが紐づいているユーザーID。
B3DdatasetID required	string 指定するB3DdatasetのID。

Responses

Response samples

200

Content type

application/json

{"id": "6833388005240832",
"jobType": "",
"userID": "4098494030324145",
"3DDatasetID": "4811188005240832",
"inputFilePath": "dummy.appspot.com/b3ddataset/4098494030324145/4811188005240832/input",
"outputFilePath": "dummy.appspot.com/b3ddataset/4098494030324145/4811188005240832/output",
"options": null,
"startAt": "2017-09-04T05:56:10Z",
"finishAt": "2017-09-04T05:57:15Z",
"status": "ready",
"error": ""
}

Upload 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

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>

Mapray API (2.0.0)

2D Datasets V2

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

エラー一覧

List Datasets

Authorizations:

query Parameters

Responses

Response samples

Create Dataset

Authorizations:

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

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 samples

Response samples

Update Feature

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required