API docs by Redocly

Scene (2.0.0)

Download OpenAPI specification:Download

シーンの作成、取得、更新、削除及びシーンエンティティの追加、取得、更新、削除を行うAPIです。

エラー一覧

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

scenev2

Scene (2.0.0)

Get Scene

所属組織に紐づくシーンを全て取得する

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 Scene

新しいシーンを作成する

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

シーン名

description
string [ 0 .. 300 ] characters

説明

x
number
Default: 0

x座標

y
number
Default: 0

y座標

z
number
Default: 0

z座標

Responses

Request samples

Content type
application/json
{
  • "name": "scene1",
  • "description": "test",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3
}

Response samples

Content type
application/json
{
  • "id": "4321567809871234",
  • "owner_id": "1234567890123456",
  • "created_at": "2021-01-01 00:00:00",
  • "updated_at": "2021-01-01 00:00:00",
  • "name": "scene1",
  • "description": "test",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3,
  • "entity_3d_id": [
    ]
}

Count Scene

所属組織に紐づくシーンの数を取得する

Authorizations:
OAuthApi-Key

Responses

Response samples

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

Retrieve Scene

指定したシーンの情報を取得する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

Responses

Response samples

Content type
application/json
{
  • "id": "24321567809871234",
  • "owner_id": "1234567890123456",
  • "created_at": "2021-01-01 00:00:00",
  • "updated_at": "2021-01-01 00:00:00",
  • "name": "scene1",
  • "description": "test",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3,
  • "entity_3d_id": [
    ]
}

Update Scene

指定したシーン情報を更新する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

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

シーン名

description
string [ 0 .. 300 ] characters

説明

x
number
Default: 0

x座標

y
number
Default: 0

y座標

z
number
Default: 0

z座標

Responses

Request samples

Content type
application/json
{
  • "name": "scene1",
  • "description": "test",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3
}

Response samples

Content type
application/json
{
  • "id": "4321567809871234",
  • "owner_id": "1234567890123456",
  • "created_at": "2021-01-01 00:00:00",
  • "updated_at": "2021-01-05 00:00:00",
  • "name": "scene1",
  • "description": "test",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3,
  • "entity_3d_id": [
    ]
}

Delete Scene

指定したシーンを削除する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

Responses

Response samples

Content type
application/json
{ }

Retrieve Mapray SceneFile Dataset

指定したシーンのmapray sceneフォーマットのJSONを取得する。

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

Responses

Response samples

Content type
application/json
{}

Get SceneEntity 3dDatasets

指定したシーンに紐づく3Dエンティティ情報を全て取得する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

query Parameters
page
integer
Default: 1

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

limit
integer [ 1 .. 100 ]
Default: 5

1ページの要素数

sort
string
Default: "updatedAt"
Enum: "updatedAt" "3ddataset_id" "name"

ソートを行うプロパティ

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

ソート方向

Responses

Response samples

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

Add SceneEntity 3dDataset

指定したシーンの3Dエンティティを追加する(複数エンティティ追加可)

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

Request Body schema: application/json
required
Array
3ddataset_id
required
string

3ddatasetID

name
required
string [ 1 .. 128 ] characters

シーンエンティティ名

x
number
Default: 0

x座標

y
number
Default: 0

y座標

z
number
Default: 0

z座標

roll
number
Default: 0

x軸の回転

tilt
number
Default: 0

y軸の回転

heading
number
Default: 0

z軸の回転

sx
number
Default: 1

x軸の縮尺

sy
number
Default: 1

y軸の縮尺

sz
number
Default: 1

z軸の縮尺

Responses

Request samples

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

Response samples

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

Update SceneEntity 3dDataset

指定したシーンの3Dエンティティを更新する(複数エンティティ更新可)

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

Request Body schema: application/json
required
Array
id
required
string

シーンエンティティID

name
required
string [ 1 .. 128 ] characters

シーンエンティティ名

x
number
Default: 0

x座標

y
number
Default: 0

y座標

z
number
Default: 0

z座標

roll
number
Default: 0

x軸の回転

tilt
number
Default: 0

y軸の回転

heading
number
Default: 0

z軸の回転

sx
number
Default: 1

x軸の縮尺

sy
number
Default: 1

y軸の縮尺

sz
number
Default: 1

z軸の縮尺

Responses

Request samples

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

Response samples

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

Retrieve SceneEntity 3dDataset

指定した3Dエンティティ情報を取得する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

seid
required
string

シーンエンティティID

Responses

Response samples

Content type
application/json
{
  • "id": "1234567890123456",
  • "scene_id": "6543210987654321",
  • "3ddataset_id": "4321567809871234",
  • "owner_id": "8877665544332211",
  • "name": "scenedata1",
  • "x": 1.1,
  • "y": 2.2,
  • "z": 3.3,
  • "roll": 1.1,
  • "tilt": 2.2,
  • "heading": 3.3,
  • "sx": 1.1,
  • "sy": 2.2,
  • "sz": 3.3,
  • "created_at": "2021-01-01 00:00:00",
  • "updated_at": "2021-01-05 00:00:00"
}

Delete SceneEntity 3dDataset

指定したシーンの3Dエンティティを削除する

Authorizations:
OAuthApi-Key
path Parameters
sid
required
string

シーンID

seid
required
string

シーンエンティティID

Responses

Response samples

Content type
application/json
{ }