Mapray 3D Dataset API (1.0.0)

Download OpenAPI specification:Download

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

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

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

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

エラー一覧

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

3ddatasetsv1

Mapray 3D Dataset API (1.0.0)

List 3D Datasets

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

Authorizations:
OAuthApi-Key
path Parameters
3DdatasetID
required
string

指定する3Ddatasetの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

Content type
application/json
[
  • {
    }
]

Create 3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
3DdatasetID
required
string

指定する3DdatasetのID

Request Body schema: application/json
src_file_type
string

コンバート前のデータフォーマット

dst_file_type
string

コンバート後のデータフォーマット

name
required
string [ 1 .. 128 ] characters

名前

description
string [ 0 .. 300 ] characters
Default: ""

説明

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軸の縮尺比率

Array of objects (attributions)
path
string

関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない

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/ で示されるコード。

altitude_mode
string
Default: "absolute"
Enum: "absolute" "relative" "clamp"

sridで指定した座標系で高度の基準

object

keyがコンバートオプションのMap

Responses

Request samples

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": {
    },
  • "attributions": []
}

Response samples

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": {
    },
  • "attributions": []
}

Count 3D Datasets

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

Authorizations:
OAuthApi-Key
path Parameters
3DdatasetID
required
string

指定する3DdatasetのID

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Retrieve 3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Responses

Response samples

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": {
    },
  • "attributions": []
}

Update 3D Dataset

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

Authorizations:
OAuthApi-Key
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: ""

説明

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軸の縮尺比率

Array of objects (attributions)

Responses

Request samples

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

Response samples

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": {
    },
  • "attributions": []
}

Delete 3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Responses

Response samples

Content type
application/json
{ }

Reset 3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Request Body schema: application/json
src_file_type
string

コンバート前のデータフォーマット

dst_file_type
string

コンバート後のデータフォーマット

name
required
string [ 1 .. 128 ] characters

名前

description
string [ 0 .. 300 ] characters
Default: ""

説明

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軸の縮尺比率

Array of objects (attributions)
path
string

関連する頂点データファイル、テクスチャなどのパスが記載されたメインとなるファイルへのパス。 1文字目は"/"で、また".."を含まない

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/ で示されるコード。

altitude_mode
string
Default: "absolute"
Enum: "absolute" "relative" "clamp"

sridで指定した座標系で高度の基準

object

keyがコンバートオプションのMap

Responses

Request samples

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": {
    },
  • "attributions": []
}

Response samples

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": {
    },
  • "attributions": []
}

Create Upload URL

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

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

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

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

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Request Body schema: application/json
required

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

Array
filename
required
string

ファイル名

content_type
required

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json

Upload 3D and Relative Data

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

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

Create Upload URLで取得したUpload URL

header Parameters
Content-Type
required
string

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

Request Body schema: application/octet-stream
object

アップロードするデータ

Responses

Request samples

Content type
application/octet-stream
No sample

Response samples

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>

Convert 3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Responses

Retrieve 3D Dataset Convert Status

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Responses

Response samples

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": [
    ],
  • "status": "queued"
}

Retrieve Mapray Scene Data

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

3D datasetを取得したいユーザーのID

query Parameters
3ddatasets_ids
required
integer
Example: 3ddatasets_ids=5106328150212608,5665678182842368

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

Responses

Response samples

Content type
application/json
{}

List Blob Files

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

Responses

Response samples

Content type
application/json
{
  • "/main/main.gltf": "5171376604315648",
  • "/texture/image0.jpg": "5646954843340800",
  • "/texture/image1.jpg": "5676392851177472"
}

Retrieve Blob File

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

Authorizations:
OAuthApi-Key
path Parameters
userID
required
string

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

3DdatasetID
required
string

指定する3DdatasetのID

path
required
string

指定するファイルパス

Responses