API docs by Redocly

Mapray Vectile Dataset API (2.0.0)

Download OpenAPI specification:Download

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

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

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

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

エラー一覧

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

vectiledatasets

Mapray Vectile Dataset API (2.0.0)

List Vectile Datasets

認証情報から得たorganizationIDに紐づく全てのVectile 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 Vectile Dataset

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

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

名前

description
string <= 300 characters
Default: ""

説明

layer_name
string <= 100 characters

データを読み込むレイヤーの名前

min_zoom
number [ 0 .. 20 ]
Default: 0
max_zoom
number or null
Default: null

nullの場合は妥当な最大ズームレベルを推測します

Array of objects (fileformat)

ファイル一覧

Array of objects (attributions)
src_file_type
string
Enum: "json" "geojson" "kml"

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

Responses

Request samples

Content type
application/json
{
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "src_file_type": "json",
  • "files": [
    ],
  • "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": "https://dummy.com/vectile/4811188005240832/mvt/",
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "files": [
    ],
  • "status": "ready",
  • "error": "",
  • "attributions": []
}

Count Vectile Datasets

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

Authorizations:
OAuthApi-Key

Responses

Response samples

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

Retrieve Vectile Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile Datasetの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": "https://dummy.com/vectile/4811188005240832/mvt/",
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "files": [
    ],
  • "status": "ready",
  • "error": "",
  • "attributions": []
}

Update Vectile Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile Datasetの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",
  • "url": "https://dummy.com/vectile/4811188005240832/mvt/",
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "files": [
    ],
  • "status": "ready",
  • "error": "",
  • "attributions": []
}

Delete Vectile Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile DatasetのID

Responses

Response samples

Content type
application/json
{ }

Reset Vectile Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile DatasetのID

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

名前

description
string <= 300 characters
Default: ""

説明

layer_name
string <= 100 characters

データを読み込むレイヤーの名前

min_zoom
number [ 0 .. 20 ]
Default: 0
max_zoom
number or null
Default: null

nullの場合は妥当な最大ズームレベルを推測します

Array of objects (fileformat)

ファイル一覧

Array of objects (attributions)
src_file_type
string
Enum: "json" "geojson" "kml"

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

Responses

Request samples

Content type
application/json
{
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "src_file_type": "json",
  • "files": [
    ],
  • "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": "https://dummy.com/vectile/4811188005240832/mvt/",
  • "name": "shinagawa_area",
  • "description": "example",
  • "layer_name": "layer",
  • "min_zoom": 4,
  • "max_zoom": 10,
  • "files": [
    ],
  • "status": "ready",
  • "error": "",
  • "attributions": []
}

Create Upload URL

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

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

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

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

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile DatasetのID

Responses

Retrieve Vectile Dataset Convert Status

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

Authorizations:
OAuthApi-Key
path Parameters
VectileDatasetID
required
string

指定するVectile DatasetのID

Responses

Response samples

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