API docs by Redocly

Mapray Image API (2.0.0)

Download OpenAPI specification:Download

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

imagedatasets

Mapray Image API (2.0.0)

List Image Datasets

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

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

Authorizations:
OAuthApi-Key
Request Body schema: application/json
name
string

名前

description
string

説明

Array of objects (attributions)
Array of objects (fileformat)

ファイル一覧

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": [
    ],
  • "attributions": [],
  • "url": "https://api.mapray.com/image/4811188005240832/",
  • "created_at": "2023-01-01T00:00:00.871648747Z",
  • "updated_at": "2023-01-05T00:00:00.871648747Z",
  • "status": "",
  • "error": ""
}

Count Image Datasets

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

Authorizations:
OAuthApi-Key

Responses

Response samples

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

Retrieve Image Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Responses

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "tokyo",
  • "description": "test",
  • "files": [
    ],
  • "attributions": [],
  • "url": "https://api.mapray.com/image/4811188005240832/",
  • "created_at": "2023-01-01T00:00:00.871648747Z",
  • "updated_at": "2023-01-05T00:00:00.871648747Z",
  • "status": "ready",
  • "error": ""
}

Update Image Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Request Body schema: application/json
name
string

名前

description
string

説明

Array of objects (attributions)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "4811188005240832",
  • "owner_id": "4098494030324145",
  • "name": "tokyo",
  • "description": "test",
  • "files": [
    ],
  • "attributions": [],
  • "url": "https://api.mapray.com/image/4811188005240832/",
  • "created_at": "2023-01-01T00:00:00.871648747Z",
  • "updated_at": "2023-01-05T00:00:00.871648747Z",
  • "status": "",
  • "error": ""
}

Delete Image Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Responses

Response samples

Content type
application/json
{ }

Reset Image Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Request Body schema: application/json
name
string

名前

description
string

説明

Array of objects (attributions)
Array of objects (fileformat)

ファイル一覧

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": [
    ],
  • "attributions": [],
  • "url": "https://api.mapray.com/image/4811188005240832/",
  • "created_at": "2023-01-01T00:00:00.871648747Z",
  • "updated_at": "2023-01-05T00:00:00.871648747Z",
  • "status": "",
  • "error": ""
}

Create Upload URL

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

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

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

Upload Image and Relative Data

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

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

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

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

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: 2022-04-01T10:00:00+00:00</Details>
</Error>

Convert Image Dataset

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Responses

Retrieve Image Dataset Convert Status

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

Authorizations:
OAuthApi-Key
path Parameters
imagedatasetID
required
string

指定するImage DatasetのID

Responses

Response samples

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