API docs by Redocly

Mapray API (2.0.0)

Download OpenAPI specification:Download

2D Datasets V2

Mapray Dataset API (2.0.0)

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

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

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

エラー一覧

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

List Datasets

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

Authorizations:
OAuthApi-KeyBearer-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

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

Create Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "3843949342039493",
  • "owner_id": "5884034982304942",
  • "name": "2D dataset",
  • "description": "example",
  • "bounds": [
    ],
  • "features": [
    ],
  • "created_at": "2019-03-11T11:09:17.855Z",
  • "updated_at": "2019-03-11T11:09:17.855Z",
  • "status": "ready",
  • "attributions": []
}

Count Datasets

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

Authorizations:
OAuthApi-KeyBearer-Token

Responses

Response samples

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

Retrieve Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Response samples

Content type
application/json
{
  • "id": "3843949342039493",
  • "owner_id": "5884034982304942",
  • "name": "2D dataset",
  • "description": "example",
  • "bounds": [
    ],
  • "features": [
    ],
  • "created_at": "2019-03-11T11:09:17.855Z",
  • "updated_at": "2019-03-11T11:09:17.855Z",
  • "status": "ready",
  • "attributions": []
}

Update Dataset

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

※部分更新はできません

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "3843949342039493",
  • "owner_id": "5884034982304942",
  • "name": "2D dataset update",
  • "description": "example update",
  • "bounds": [
    ],
  • "features": [
    ],
  • "created_at": "2019-03-11T11:09:17.855Z",
  • "updated_at": "2019-04-08T18:35:02.322Z",
  • "status": "ready",
  • "attributions": []
}

Reset Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

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

Delete Dataset

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

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

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Response samples

Content type
application/json
{ }

Create Upload URL

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

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

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

Get Dataset File List

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Response samples

Content type
application/json
[
  • "test.kml",
  • "test.gpx"
]

List Features

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Insert Feature

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{
  • "id": "5100199366098944",
  • "geometry": {
    },
  • "properties": {
    },
  • "mapray": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    },
  • "id": "geo json id",
  • "mapray": {
    }
}

Insert MultiFeatures

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Update Feature

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{
  • "id": "62707111317995529",
  • "geometry": {
    },
  • "properties": {
    },
  • "mapray": {
    }
}

Response samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    },
  • "id": "geo json id",
  • "mapray": {
    }
}

Retrieve Feature

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
maprayFeatureID
required
string

指定するfeatureのID。

Responses

Response samples

Content type
application/json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    },
  • "id": "geo json id",
  • "mapray": {
    }
}

Delete Feature

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
maprayFeatureID
required
string

指定するfeatureのID。

Responses

Response samples

Content type
application/json
{ }

Convert 2D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Retrieve 2D Dataset Convert Status

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
datasetID
required
string

指定するdatasetのID。

Responses

Response samples

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

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シーンファイルに相当します。

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

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

エラー一覧

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

List 3D Datasets

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[
  • {
    }
]

Create 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

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

Count 3D Datasets

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

Authorizations:
OAuthApi-KeyBearer-Token

Responses

Response samples

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

Retrieve 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
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/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": {
    },
  • "attributions": []
}

Update 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

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

Delete 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
3DdatasetID
required
string

指定する3DdatasetのID。

Responses

Response samples

Content type
application/json
{ }

Reset 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

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

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:
OAuthApi-KeyBearer-Token
path Parameters
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
[]

Convert 3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
3DdatasetID
required
string

指定する3DdatasetのID。

Responses

Retrieve 3D Dataset Convert Status

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
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-KeyBearer-Token
path Parameters
3ddatasets_ids
required
string
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-KeyBearer-Token
path Parameters
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-KeyBearer-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

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次元の点群データを意味します。

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

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

エラー一覧

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

List PC Datasets

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[]

Create PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{}

Count PC Datasets

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

Authorizations:
OAuthApi-KeyBearer-Token

Responses

Response samples

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

Retrieve PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID。

Responses

Response samples

Content type
application/json
{}

Update PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID。

Responses

Response samples

Content type
application/json
{ }

Reset PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{}

Create Upload URL

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

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

指定するPCdatasetの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
[]

Convert PC Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID。

Responses

Retrieve PC Dataset Convert Status

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID。

Responses

Response samples

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

Download PC Dataset source file

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

Authorizations:
OAuthApi-KeyBearer-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

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データを意味します。

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

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

エラー一覧

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

List B3D Datasets

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[
  • {
    }
]

Create B3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "shinagawa_area",
  • "description": "test",
  • "attributions": [],
  • "srid": 4326,
  • "format": "b3d",
  • "url": "https://dummy.com/b3d/4811188005240832/",
  • "fileinfo": {
    },
  • "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:
OAuthApi-KeyBearer-Token

Responses

Response samples

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

Retrieve B3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID。

Responses

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "shinagawa_area",
  • "description": "test",
  • "attributions": [],
  • "srid": 4326,
  • "format": "b3d",
  • "url": "https://dummy.com/b3d/4811188005240832/",
  • "fileinfo": {
    },
  • "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:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "shinagawa_area",
  • "description": "test",
  • "attributions": [],
  • "srid": 4326,
  • "format": "b3d",
  • "url": "https://dummy.com/b3d/4811188005240832/",
  • "fileinfo": {
    },
  • "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:
OAuthApi-KeyBearer-Token
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID。

Responses

Response samples

Content type
application/json
{ }

Reset B3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "shinagawa_area",
  • "description": "test",
  • "attributions": [],
  • "srid": 4326,
  • "format": "b3d",
  • "url": "https://dummy.com/b3d/4811188005240832/",
  • "fileinfo": {
    },
  • "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:
OAuthApi-KeyBearer-Token
path Parameters
B3DdatasetID
required
string

指定するB3Ddatasetの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
[]

Convert B3D Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID。

Responses

Retrieve B3D Dataset Convert Status

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID。

Responses

Response samples

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

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はラスターおよびベクター地理空間情報データを意味します。

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

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

エラー一覧

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

List Tilesets

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[
  • {
    }
]

Create Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    },
  • "src_file_type": "geotiff",
  • "attributions": []
}

Response samples

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": [],
  • "statuses": [
    ],
  • "info": {
    },
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    }
}

Count Tileset Datasets

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

Authorizations:
OAuthApi-KeyBearer-Token

Responses

Response samples

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

Retrieve Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
TilesetDatasetID
required
string

指定するTilesetDatasetのID。

Responses

Response samples

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": [],
  • "statuses": [
    ],
  • "info": {
    },
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    }
}

Update Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{}

Response samples

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": [],
  • "statuses": [
    ],
  • "info": {
    },
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    }
}

Delete Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
TilesetDatasetID
required
string

指定するTilesetDatasetのID。

Responses

Response samples

Content type
application/json
No sample

Reset Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    },
  • "src_file_type": "geotiff",
  • "attributions": []
}

Response samples

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": [],
  • "statuses": [
    ],
  • "info": {
    },
  • "name": "tokyo",
  • "description": "test",
  • "srid": 2451,
  • "tiles": {
    },
  • "contour": {
    },
  • "heightmap": {
    },
  • "image": {
    }
}

Create Upload URL

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

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

指定するTilesetDatasetの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
[]

Convert Tileset Dataset

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
TilesetDatasetID
required
string

指定するTilesetDatasetのID。

Request Body schema: application/json
types
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

List Tileset Dataset Convert Statuses

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

Authorizations:
OAuthApi-KeyBearer-Token
path Parameters
TilesetDatasetID
required
string

指定するTilesetDatasetのID。

Responses

Response samples

Content type
application/json
[]

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

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は画像データを意味します。

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

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

エラー一覧

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

List Image Datasets

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
[
  • {
    }
]

Create Image Dataset

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

Authorizations:
OAuthApi-KeyBearer-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

Content type
application/json
{
  • "name": "tokyo",
  • "description": "test",
  • "files": [
    ],
  • "attributions": []
}

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "tokyo",
  • "description": "test",
  • "files":