API docs by Redocly

Mapray Point Cloud Dataset API (2.0.0)

Download OpenAPI specification:Download

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 該当データが存在しません

pcdatasetsv2

Mapray Point Cloud Dataset API (2.0.0)

List PC Datasets

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

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

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

名前

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

説明

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

x
number
Default: 0

sridで指定した座標系での位置 x (座標系の定義による)

y
number
Default: 0

sridで指定した座標系での位置 y (座標系の定義による)

z
number
Default: 0

sridで指定した座標系での位置 z (座標系の定義による)

xyz_type
integer

xyzフォーマットの種類番号

object

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

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

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

dst_file_type
string
Value: "raw"

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

Responses

Request samples

Content type
application/json
{
  • "name": "tokyo",
  • "description": "test",
  • "srid": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "src_file_type": "las",
  • "dst_file_type": "raw",
  • "attributions": []
}

Response samples

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": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "status": "ready",
  • "bbox": [
    ],
  • "content_root": [
    ],
  • "attributions": []
}

Count PC Datasets

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

Authorizations:
OAuthApi-Key

Responses

Response samples

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

Retrieve PC Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID

Responses

Response samples

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": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "status": "ready",
  • "bbox": [
    ],
  • "content_root": [
    ],
  • "attributions": []
}

Update PC Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
PCdatasetID
required
string

指定するPCdatasetの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": "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": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "status": "ready",
  • "bbox": [
    ],
  • "content_root": [
    ],
  • "attributions": []
}

Delete PC Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID

Responses

Response samples

Content type
application/json
{ }

Reset PC Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID

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

名前

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

説明

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

x
number
Default: 0

sridで指定した座標系での位置 x (座標系の定義による)

y
number
Default: 0

sridで指定した座標系での位置 y (座標系の定義による)

z
number
Default: 0

sridで指定した座標系での位置 z (座標系の定義による)

xyz_type
integer

xyzフォーマットの種類番号

object

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

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

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

dst_file_type
string
Value: "raw"

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

Responses

Request samples

Content type
application/json
{
  • "name": "tokyo",
  • "description": "test",
  • "srid": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "src_file_type": "las",
  • "dst_file_type": "raw",
  • "attributions": []
}

Response samples

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": 4326,
  • "x": 1,
  • "y": 2,
  • "z": 3,
  • "xyz_type": 0,
  • "status": "ready",
  • "bbox": [
    ],
  • "content_root": [
    ],
  • "attributions": []
}

Create Upload URL

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

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

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

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

Authorizations:
OAuthApi-Key
path Parameters
PCdatasetID
required
string

指定するPCdatasetのID

Responses

Retrieve PC Dataset Convert Status

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

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