Mapray Building 3D Dataset API (2.0.0)

Download OpenAPI specification:Download

Mapray Building 3D Dataset API は3次元地理空間の建物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 該当データが存在しません

b3ddatasetsv2

Mapray Building 3D Dataset API (2.0.0)

List B3D Datasets

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

Authorizations:
OAuthApi-Key
query Parameters
page
integer >= 1
Default: 1

1ページの要素数がlimitの場合のページ番号

limit
integer [ 1 .. 100 ]
Default: 5

1ページの要素数

sort
string
Default: "updatedAt"
Enum: "id" "name" "updatedAt"

ソートを行うプロパティ

direction
string
Default: "desc"
Enum: "asc" "desc"

ソート方向

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create B3D Dataset

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

Authorizations:
OAuthApi-Key
Request Body schema: application/json
name
required
string [ 1 .. 128 ] characters

名前

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

説明

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

Array of objects (attributions)
src_file_type
string
Value: "gml"

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

dst_file_type
string
Value: "b3d"

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

Responses

Request samples

Content type
application/json
{}

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",
  • "format": "b3d",
  • "name": "shinagawa_area",
  • "description": "test",
  • "srid": 4326,
  • "status": "ready",
  • "fileinfo": {
    },
  • "attributions": []
}

Count B3D Datasets

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

Authorizations:
OAuthApi-Key

Responses

Response samples

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

Retrieve B3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3Ddatasetの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",
  • "format": "b3d",
  • "name": "shinagawa_area",
  • "description": "test",
  • "srid": 4326,
  • "status": "ready",
  • "fileinfo": {
    },
  • "attributions": []
}

Update B3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID

Request Body schema: application/json
name
required
string [ 1 .. 128 ] characters

名前

description
string [ 0 .. 300 ] characters

説明

Array of objects (attributions)

Responses

Request samples

Content type
application/json
{}

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",
  • "format": "b3d",
  • "name": "shinagawa_area",
  • "description": "test",
  • "srid": 4326,
  • "status": "ready",
  • "fileinfo": {
    },
  • "attributions": []
}

Delete B3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID

Responses

Response samples

Content type
application/json
{ }

Reset B3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID

Request Body schema: application/json
name
required
string [ 1 .. 128 ] characters

名前

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

説明

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

Array of objects (attributions)
src_file_type
string
Value: "gml"

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

dst_file_type
string
Value: "b3d"

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

Responses

Request samples

Content type
application/json
{}

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",
  • "format": "b3d",
  • "name": "shinagawa_area",
  • "description": "test",
  • "srid": 4326,
  • "status": "ready",
  • "fileinfo": {
    },
  • "attributions": []
}

Create Upload URL

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

  • アップロードファイルごとにURLを取得します。
  • upload URLの有効期間は15分になります。
  • 同一のupload URLは有効期間内であれば何回でも使用できます。
  • upload URLは何回でも作り直せます。
Authorizations:
OAuthApi-Key
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
[]

Upload B3D 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 B3D Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID

Responses

Retrieve B3D Dataset Convert Status

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

Authorizations:
OAuthApi-Key
path Parameters
B3DdatasetID
required
string

指定するB3DdatasetのID

Responses

Response samples

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