コンテンツにスキップ

GraphQL スキーマリファレンス

PLATEAU GraphQL API のクエリルート。

Field Argument Type Description
node Node

指定されたIDでオブジェクトを取得します。

id ID!
nodes [Node]!

指定されたIDのリストからオブジェクトを検索します。

ids [ID!]!
area Area

地域コード(都道府県コードや市区町村コード)で地域を取得します。

code AreaCode!
areas [Area!]!

地域を検索します。

input AreasInput
datasetTypes [DatasetType!]!

データセットの種類を検索します。

input DatasetTypesInput
datasets [Dataset!]!

データセットを検索します。

input DatasetsInput
plateauSpecs [PlateauSpec!]!

利用可能な全てのPLATEAU都市モデルの仕様を取得します。

years [Int!]!

利用可能な全てのデータセットの年度(西暦)を取得します。

市区町村

Field Argument Type Description
id ID!
type AreaType!

地域の種類

code AreaCode!

市区町村コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

name String!

市区町村名

prefectureId ID!

市区町村が属する都道府県のID。

prefectureCode AreaCode!

市区町村が属する都道府県コード。2桁の数字から成る文字列です。

prefecture Prefecture

市区町村の都道府県。

wards [Ward!]!

市区町村に属する区。政令指定都市の場合のみ存在します。

datasets [Dataset!]!

市区町村に属するデータセット(DatasetInput内のareasCodeの指定は無視されます)。

input DatasetsInput
parentId ID

地域の親となる地域のID。市区町村の親は都道府県です。政令指定都市の区の親は市です。

parent Prefecture!

地域の親となる地域。

planarCrsEpsgCode String

平面直角座標系のEPSGコード。例えば、東京都の場合は “6677” です。

citygmlId ID

CityGMLデータセットのID。

citygml CityGMLDataset

CityGMLデータセット。

children [Area!]!

地域に属する子地域。

PLATEAU標準製品仕様書に基づくCityGMLのデータセット。

Field Argument Type Description
id ID!
year Int!

データセットの整備年度(西暦)。

registrationYear Int!

データセットの登録年度(西暦)。

prefectureId ID!

データセットが属する都道府県のID。

prefectureCode AreaCode!

データセットが属する都道府県コード。2桁の数字から成る文字列です。

cityId ID!

データセットが属する市のID。

cityCode AreaCode!

データセットが属する市コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

plateauSpecMinorId ID!

データセットが準拠するPLATEAU都市モデルの仕様のマイナーバージョンへのID。

url String!

CityGMLのzip形式のファイルのURL。

gspatialjpDatasetUrl String

G空間情報センターへのURL。

prefecture Prefecture!

データセットが属する都道府県。

city City!

データセットが属する市。

plateauSpecMinor PlateauSpecMinor!

データセットが準拠するPLATEAU都市モデルの仕様。

featureTypes [String!]!

CityGMLが含む地物型コードのリスト。

metadataZipUrls [String!]!

CityGMLのメタデータを含むzipファイルURLのリスト。

admin Any

管理者用

ユースケースデータなどを含む、その他のデータセット。

Field Argument Type Description
id ID!
name String!

データセット名

description String

データセットの説明

year Int!

データセットの整備年度(西暦)

registerationYear Int!

データセットの公開年度(西暦)

groups [String!]

データセットを分類するグループ。グループが階層構造になっている場合は、親から子の順番で複数のグループ名が存在することがあります。

openDataUrl String

データセットの公開データのURL。

prefectureId ID

データセットが属する都道府県のID。

prefectureCode AreaCode

データセットが属する都道府県コード。2桁の数字から成る文字列です。

cityId ID

データセットが属する市のID。

cityCode AreaCode

データセットが属する市コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

wardId ID

データセットが属する区のID。

wardCode AreaCode

データセットが属する区コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

typeId ID!

データセットの種類のID。

typeCode String!

データセットの種類コード。

prefecture Prefecture

データセットが属する都道府県。

city City

データセットが属する市。

ward Ward

データセットが属する区。

type GenericDatasetType!

データセットの種類。

items [GenericDatasetItem!]!

データセットのアイテム。

ar Boolean!

PLATEAU ARで閲覧可能なデータセットかどうか。

admin Any

管理者用

その他のデータセットのアイテム。

Field Argument Type Description
id ID!
format DatasetFormat!

データセットのアイテムのフォーマット。

name String!

データセットのアイテム名。

url String!

データセットのアイテムのURL。

layers [String!]

データセットのアイテムのレイヤー名。MVTやWMSなどのフォーマットの場合のみ存在。 レイヤー名が複数存在する場合は、同時に複数のレイヤーを表示可能であることを意味します。

parentId ID!

データセットのアイテムが属するデータセットのID。

parent GenericDataset

データセットのアイテムが属するデータセット。

その他のデータセットの種類。

Field Argument Type Description
id ID!
code String!

データセットの種類コード。「usecase」など。

name String!

データセットの種類名。

category DatasetTypeCategory!

データセットの種類のカテゴリ。

order Int!

データセットの種類の順番を示す数字。大きいほど後に表示されます。

datasets [GenericDataset!]!

データセット(DatasetInput内のincludeTypesとexcludeTypesの指定は無視されます)。

input DatasetsInput

全球(グローバル)エリア。特定の地域に属さない全球データを扱うための特殊なエリア。

Field Argument Type Description
id ID!
type AreaType!

地域の種類

code AreaCode!

地域コード。“global” という固定値。

name String!

地域名。“全球” という固定値。

datasets [Dataset!]!

全球データセット(DatasetInput内のareasCodeの指定は無視されます)。

input DatasetsInput
parentId ID

地域の親となる地域のID。GlobalAreaの場合は常にnull。

parent Area

地域の親となる地域。GlobalAreaの場合は常にnull。

children [Area!]!

地域に属する子地域。GlobalAreaの場合は常に空配列。

PLATEAU都市モデルの通常のデータセット。例えば、地物型が建築物モデル(bldg)などのデータセットです。

Field Argument Type Description
id ID!
name String!

データセット名

subname String

データセットのサブ名。都市計画決定情報の○○区域や洪水浸水想定区域の河川名などが含まれます。

subcode String

データセットのサブコード。都市計画決定情報の○○区域や洪水浸水想定区域の河川名などのコード表現が含まれます。

suborder Int

データセットのサブコードの順番。大きいほど後に表示されます。

description String

データセットの説明

year Int!

データセットの整備年度(西暦)

registerationYear Int!

データセットの公開年度(西暦)

groups [String!]

データセットを分類するグループ。グループが階層構造になっている場合は、親から子の順番で複数のグループ名が存在することがあります。

openDataUrl String

データセットの公開データのURL。

prefectureId ID

データセットが属する都道府県のID。

prefectureCode AreaCode

データセットが属する都道府県コード。2桁の数字から成る文字列です。

cityId ID

データセットが属する市のID。

cityCode AreaCode

データセットが属する市コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

wardId ID

データセットが属する区のID。

wardCode AreaCode

データセットが属する区コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

typeId ID!

データセットの種類のID。

typeCode String!

データセットの種類コード。

prefecture Prefecture

データセットが属する都道府県。

city City

データセットが属する市。

ward Ward

データセットが属する区。

type PlateauDatasetType!

データセットの種類。

items [PlateauDatasetItem!]!

データセットのアイテム。

ar Boolean!

PLATEAU ARで閲覧可能なデータセットかどうか。

admin Any

管理者用

plateauSpecMinorId ID!

データセットが準拠するPLATEAU都市モデルの仕様のマイナーバージョンへのID。

plateauSpecMinor PlateauSpecMinor!

データセットが準拠するPLATEAU都市モデルの仕様。

river River

河川。地物型が洪水浸水想定区域モデル(fld)の場合のみ存在します。

PLATEAU都市モデルのデータセットのアイテム。

Field Argument Type Description
id ID!
format DatasetFormat!

データセットのアイテムのフォーマット。

name String!

データセットのアイテム名。

url String!

データセットのアイテムのURL。

layers [String!]

データセットのアイテムのレイヤー名。MVTやWMSなどのフォーマットの場合のみ存在。 レイヤー名が複数存在する場合は、同時に複数のレイヤーを表示可能であることを意味します。

parentId ID!

データセットのアイテムが属するデータセットのID。

parent PlateauDataset

データセットのアイテムが属するデータセット。

lod Int

データセットのアイテムのLOD(詳細度・Level of Detail)。1、2、3、4などの整数値です。

lodEx Int

データセットのアイテムのLOD(詳細度・Level of Detail)のうち、小数点以下の値が存在する場合に定義されます。例えばLOD3.1の場合は1、3.0の場合は0となります。LODがnullの場合はnullとなります。

texture Texture

データセットのアイテムのテクスチャの種類。

floodingScale FloodingScale

浸水規模。地物型が災害リスク(浸水)モデルの場合のみ存在することがあります。

floodingScaleSuffix String

浸水規模の枝番。地物型が災害リスク(浸水)モデルの場合のみ存在することがあります。

PLATEAU都市モデルのデータセットの種類。

Field Argument Type Description
id ID!
code String!

データセットの種類コード。「bldg」など。

name String!

データセットの種類名。

category DatasetTypeCategory!

データセットの種類のカテゴリ。

order Int!

データセットの種類の順番を示す数字。大きいほど後に表示されます。

plateauSpecId ID!

データセットの種類が属するPLATEAU都市モデルの仕様のID。

plateauSpec PlateauSpec

データセットの種類が属するPLATEAU都市モデルの仕様。

year Int!

データセットの種類が属するPLATEAU都市モデルの仕様の公開年度(西暦)。

flood Boolean!

災害リスク(浸水)モデルかどうか。河川などの情報が利用可能です。

datasets [PlateauDataset!]!

データセット(DatasetInput内のincludeTypesとexcludeTypesの指定は無視されます)。

input DatasetsInput

PLATEAU都市モデルの仕様のメジャーバージョン。

Field Argument Type Description
id ID!
majorVersion Int!

PLATEAU都市モデルの仕様のバージョン番号。

year Int!

仕様の公開年度(西暦)。

datasetTypes [PlateauDatasetType!]!

その仕様に含まれるデータセットの種類。

minorVersions [PlateauSpecMinor!]!

その仕様のマイナーバージョン。

PLATEAU都市モデルの仕様のマイナーバージョン。

Field Argument Type Description
id ID!
name String!

PLATEAU都市モデルの仕様の名前。 “第2.3版” のような文字列です。

version String!

バージョンを表す文字列。 “2.3” のような文字列です。

majorVersion Int!

メジャーバージョン番号。 2のような整数です。

year Int!

仕様の公開年度(西暦)。

parentId ID!

その仕様が属する仕様のメジャーバージョンのID。

parent PlateauSpec!

その仕様が属する仕様のメジャーバージョン。

datasets [Dataset!]!

その仕様に準拠して整備されたPLATEAU都市モデルデータセット(DatasetInput内のplateauSpecの指定は無視されます)。

input DatasetsInput

都道府県

Field Argument Type Description
id ID!
type AreaType!

地域の種類

code AreaCode!

都道府県コード。2桁の数字から成る文字列です。

name String!

都道府県名

cities [City!]!

都道府県に属する市区町村

datasets [Dataset!]!

都道府県に属するデータセット(DatasetInput内のareasCodeの指定は無視されます)。

input DatasetsInput
parentId ID

地域の親となる地域のID。市区町村の親は都道府県です。政令指定都市の区の親は市です。

parent Area

地域の親となる地域。

children [Area!]!

地域に属する子地域。

PLATEAU都市モデルデータセットと併せて表示することで情報を補完できる、関連データセット。 避難施設・ランドマーク・鉄道駅・鉄道・緊急輸送道路・公園・行政界などのデータセット。

Field Argument Type Description
id ID!
name String!

データセット名

description String

データセットの説明

year Int!

データセットの整備年度(西暦)

registerationYear Int!

データセットの公開年度(西暦)

groups [String!]

データセットを分類するグループ。グループが階層構造になっている場合は、親から子の順番で複数のグループ名が存在することがあります。

openDataUrl String

データセットの公開データのURL。

prefectureId ID

データセットが属する都道府県のID。

prefectureCode AreaCode

データセットが属する都道府県コード。2桁の数字から成る文字列です。

cityId ID

データセットが属する市のID。

cityCode AreaCode

データセットが属する市コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

wardId ID

データセットが属する区のID。

wardCode AreaCode

データセットが属する区コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

typeId ID!

データセットの種類のID。

typeCode String!

データセットの種類コード。

prefecture Prefecture

データセットが属する都道府県。

city City

データセットが属する市。

ward Ward

データセットが属する区。

type RelatedDatasetType!

データセットの種類。

items [RelatedDatasetItem!]!

データセットのアイテム。

ar Boolean!

PLATEAU ARで閲覧可能なデータセットかどうか。

admin Any

管理者用

関連データセットのアイテム。

Field Argument Type Description
id ID!
format DatasetFormat!

データセットのアイテムのフォーマット。

name String!

データセットのアイテム名。

url String!

データセットのアイテムのURL。

originalFormat DatasetFormat

データセットのアイテムの変換前データのフォーマット。 originalUrlフィールドが存在する場合のみ存在します。

originalUrl String

データセットのアイテムの変換前データのURL。 鉄道駅情報・ランドマーク情報はurlフィールドではCZML形式で提供されていますが、元となったGeoJSONデータが存在します。

layers [String!]

データセットのアイテムのレイヤー名。MVTやWMSなどのフォーマットの場合のみ存在。 レイヤー名が複数存在する場合は、同時に複数のレイヤーを表示可能であることを意味します。

parentId ID!

データセットのアイテムが属するデータセットのID。

parent RelatedDataset

データセットのアイテムが属するデータセット。

関連データセットの種類。

Field Argument Type Description
id ID!
code String!

データセットの種類コード。「park」など。

name String!

データセットの種類名。

category DatasetTypeCategory!

データセットの種類のカテゴリ。

order Int!

データセットの種類の順番を示す数字。大きいほど後に表示されます。

datasets [RelatedDataset!]!

データセット(DatasetInput内のincludeTypesとexcludeTypesの指定は無視されます)。

input DatasetsInput

洪水浸水想定区域モデルにおける河川。

Field Argument Type Description
name String!

河川名。通常、「〜水系〜川」という形式になります。

admin RiverAdmin!

管理区間

区(政令指定都市のみ)

Field Argument Type Description
id ID!
type AreaType!

種類

code AreaCode!

区コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

name String!

区名

prefectureId ID!

区が属する都道府県のID。

prefectureCode AreaCode!

区が属する都道府県コード。2桁の数字から成る文字列です。

cityId ID!

区が属する市のID。

cityCode AreaCode!

区が属する市のコード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

prefecture Prefecture

区が属する都道府県。

city City

区が属する市。

datasets [Dataset!]!

区に属するデータセット(DatasetInput内のareasCodeの指定は無視されます)。

input DatasetsInput
parentId ID

地域の親となる地域のID。市区町村の親は都道府県です。政令指定都市の区の親は市です。

parent City!

地域の親となる地域。

children [Area!]!

地域に属する子地域。

地域を検索するためのクエリ。

Field Type Description
parentCode AreaCode

検索したい地域が属する親となる地域のコード。例えば東京都に属する都市を検索したい場合は “13” を指定します。

datasetTypes [String!]

データセットの種類コード。例えば、建築物モデルのデータセットが存在する地域を検索したい場合は “bldg” を指定します。複数指定するとOR条件で検索を行います。 未指定の場合、全てのデータセットの種類を対象に検索します。

categories [DatasetTypeCategory!]

データセットの種類のカテゴリ。例えば、PLATEAU都市モデルデータセットが存在する地域を検索したい場合は PLATEAU を指定します。複数指定するとOR条件で検索を行います。 未指定の場合、全てのカテゴリのデータセットを対象に検索します。

areaTypes [AreaType!]

地域の種類。例えば、市を検索したい場合は CITY を指定します。複数指定するとOR条件で検索を行います。 未指定の場合、全ての地域を対象に検索します。

searchTokens [String!]

検索文字列。複数指定するとAND条件で絞り込み検索が行えます。

includeParents Boolean

datasetTypes が指定された場合に、検索結果にその地域の親も含めるかどうか。デフォルトは false です。

includeEmpty Boolean

属しているDatasetが存在しない都市を含めます。通常のデータセットは存在しないが、 CityGMLDataset の city として使用されている都市が含まれます。

deep Boolean

parentCode が指定された場合に、その地域に間接的に属している地域も検索対象にするかどうか。デフォルトは false です。

データセットの種類を検索するためのクエリ。

Field Type Description
category DatasetTypeCategory

データセットの種類のカテゴリ。

plateauSpec String

データセットの種類が属するPLATEAU都市モデルの仕様名。

year Int

データセットの種類が属するPLATEAU都市モデルの仕様の公開年度(西暦)。

データセットを検索するためのクエリ。

Field Type Description
areaCodes [AreaCode!]

データセットの地域コード(都道府県コードや市区町村コードが使用可能)。複数指定するとOR条件で検索を行います。

plateauSpec String

仕様書のバージョン。「第2.3版」「2.3」「2」などの文字列が使用可能です。

year Int

データの整備年度(西暦)。

registrationYear Int

データの公開年度(西暦)。

excludeTypes [String!]

検索結果から除外するデータセットの種類コード。種類コードは例えば “bldg”(建築物モデル)の他、“plateau”(PLATEAU都市モデルデータセット)、“related”(関連データセット)、“generic”(その他のデータセット)が使用可能です。

includeTypes [String!]

検索結果に含めるデータセットの種類コード。未指定の場合、全てのデータセットの種類を対象に検索し、指定するとその種類で検索結果を絞り込みます。種類コードは例えば “bldg”(建築物モデル)の他、“plateau”(PLATEAU都市モデルデータセット)、“related”(関連データセット)、“generic”(その他のデータセット)が使用可能です。

searchTokens [String!]

検索文字列。複数指定するとAND条件で絞り込み検索が行えます。

shallow Boolean

areaCodesで指定された地域に直接属しているデータセットのみを検索対象にするかどうか。 デフォルトはfalseで、指定された地域に間接的に属するデータセットも全て検索します。 例えば、札幌市を対象にした場合、札幌市には中央区や北区といった区のデータセットも存在しますが、trueにすると札幌市のデータセットのみを返します。

groupedOnly Boolean

特殊なグループを持つデータセットのみを検索対象にするかどうか。デフォルトはfalseです。

ar Boolean

PLATEAU ARで閲覧可能なデータセットを含めるかどうか。 trueの場合はARで閲覧可能なデータセットのみ、falseの場合はARで閲覧不可能なデータセットのみを返します。

Value Description
PREFECTURE

都道府県

CITY

市町村

WARD

区(政令指定都市のみ)

GLOBAL

全球(グローバル)

データセットのフォーマット。

Value Description
CSV

CSV

CZML

CZML

CESIUM3DTILES

3D Tiles

GLTF

GlTF

GTFS_REALTIME

GTFS Realtime

GEOJSON

GeoJSON

MVT

Mapbox Vector Tile

TMS

Tile Map Service

TILES

XYZで分割された画像タイル。/{z}/{x}/{y}.png のようなURLになります。

WMS

Web Map Service

データセットの種類のカテゴリ。

Value Description
PLATEAU

PLATEAU都市モデルデータセット

RELATED

関連データセット

GENERIC

その他のデータセット

浸水想定区域モデルにおける浸水規模。

Value Description
PLANNED

計画規模

EXPECTED_MAXIMUM

想定最大規模

河川の管理区間

Value Description
NATIONAL

国管理区間

PREFECTURE

都道府県管理区間

建築物モデルのテクスチャの種類。

Value Description
NONE

テクスチャなし

TEXTURE

テクスチャあり

行政コードを表す文字列。 都道府県の場合は、2桁の数字で構成された文字列です。 自治体の場合は、先頭に2桁の都道府県コードを含む、5桁の数字で構成された文字列です。

The Boolean scalar type represents true or false.

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

地域。都道府県(Prefecture)・市区町村(City)・区(政令指定都市のみ・Ward)のいずれかです。 政令指定都市の場合のみ、市の下に区が存在します。

Field Argument Type Description
id ID!
type AreaType!

地域の種類

code AreaCode!

地域コード。行政コードや市区町村コードとも呼ばれます。 都道府県の場合は二桁の数字から成る文字列です。 市区町村の場合は、先頭に都道府県コードを含む5桁の数字から成る文字列です。

name String!

地域名

datasets [Dataset!]!

地域に属するデータセット(DatasetInput内のareasCodeの指定は無視されます)。

input DatasetsInput
parentId ID

地域の親となる地域のID。市区町村の親は都道府県です。政令指定都市の区の親は市です。

parent Area

地域の親となる地域。

children [Area!]!

地域に属する子地域。

Possible Types: City, GlobalArea, Prefecture, Ward

データセット。

Field Argument Type Description
id ID!
name String!

データセット名

description String

データセットの説明

year Int!

データセットの整備年度(西暦)

registerationYear Int!

データセットの登録年度(西暦)

groups [String!]

データセットを分類するグループ。グループが階層構造になっている場合は、親から子の順番で複数のグループ名が存在することがあります。

openDataUrl String

データセットの公開データのURL。

prefectureId ID

データセットが属する都道府県のID。

prefectureCode AreaCode

データセットが属する都道府県コード。2桁の数字から成る文字列です。

cityId ID

データセットが属する市のID。

cityCode AreaCode

データセットが属する市コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

wardId ID

データセットが属する区のID。

wardCode AreaCode

データセットが属する区コード。先頭に都道府県コードを含む5桁の数字から成る文字列です。

typeId ID!

データセットの種類のID。

typeCode String!

データセットの種類コード。

prefecture Prefecture

データセットが属する都道府県。

city City

データセットが属する市。

ward Ward

データセットが属する区。

type DatasetType!

データセットの種類。

items [DatasetItem!]!

データセットのアイテム。

ar Boolean!

PLATEAU ARで閲覧可能なデータセットかどうか。

admin Any

管理者用

Possible Types: GenericDataset, PlateauDataset, RelatedDataset

データセットのアイテム。

Field Argument Type Description
id ID!
format DatasetFormat!

データセットのアイテムのフォーマット。

name String!

データセットのアイテム名。

url String!

データセットのアイテムのURL。

layers [String!]

データセットのアイテムのレイヤー名。MVTやWMSなどのフォーマットの場合のみ存在。 レイヤー名が複数存在する場合は、同時に複数のレイヤーを表示可能であることを意味します。

parentId ID!

データセットのアイテムが属するデータセットのID。

parent Dataset

データセットのアイテムが属するデータセット。

Possible Types: GenericDatasetItem, PlateauDatasetItem, RelatedDatasetItem

データセットの種類。

Field Argument Type Description
id ID!
code String!

データセットの種類コード。 “bldg” など。

name String!

データセットの種類名。

category DatasetTypeCategory!

データセットの種類のカテゴリ。

order Int!

データセットの種類の順番を示す数字。大きいほど後に表示されます。

datasets [Dataset!]!

データセット(DatasetInput内のincludeTypesとexcludeTypesの指定は無視されます)。

input DatasetsInput

Possible Types: GenericDatasetType, PlateauDatasetType, RelatedDatasetType

IDを持つオブジェクト。nodeまたはnodesクエリでIDを指定して検索可能です。

Field Argument Type Description
id ID!

オブジェクトのID

Possible Types: City, CityGMLDataset, GenericDataset, GenericDatasetItem, GenericDatasetType, GlobalArea, PlateauDataset, PlateauDatasetItem, PlateauDatasetType, PlateauSpec, PlateauSpecMinor, Prefecture, RelatedDataset, RelatedDatasetItem, RelatedDatasetType, Ward