インフラ管理DX領域API (1.0.0)

Download OpenAPI specification:Download

インフラ管理DX領域の4次元時空間情報基盤で使用するAPIです

1.設備データ登録業務

設備データ取込依頼

リクエスト情報のファイルをもとに4次元時空間情報基盤に設備データ取込依頼を行う。設備データ取込は非同期で実行する。

Request Body schema: multipart/form-data

file required	string <binary> ファイル
datasetId required	string データセットID

Responses

Response samples

200
400
500

Content type

application/json

{"taskId": "string"
}

設備データ取込状況確認

リクエスト情報をもとに、設備データ取込状況を取得する。設備データ取込状況を確認するために利用する。

query Parameters

taskId	string タスクID
registFacilityReqDateFrom	string <date-time> 設備データ取込依頼日時（From）
registFacilityReqDateTo	string <date-time> 設備データ取込依頼日時（To）
taskStatus	string タスク状況

Responses

Response samples

200
400
500

Content type

application/json

{"taskList": [{"taskId": "string",
"registFacilityReqDate": "2019-08-24T14:15:22Z",
"registFacilityExecDate": "2019-08-24T14:15:22Z",
"taskStatus": "string"
}
]
}

2.設備データ出力業務

設備データ出力

リクエスト情報をもとに、設備データ出力範囲の空間ID、属性情報を取得する。

Request Body schema: application/json

request

sid required	string 空間ID
datasetId	Array of strings データセットID（配列）

Responses

Request samples

Payload

Content type

application/json

{"sid": "string",
"datasetId": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"datasetIdList": [{"datasetId": "string",
"sid": ["string"
],
"attribute": ["string"
]
}
]
}

3.設備データの事業者確認業務

設備データ所有確認

空間IDと現在管理している設備データとの突合せを行い、インフラ事業者を特定する。

Request Body schema: application/json

request

sid required	Array of strings 空間ID（配列）
datasetId	Array of strings データセットID（配列）

Responses

Request samples

Payload

Content type

application/json

{"sid": ["string"
],
"datasetId": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"companyList": [{"companyCode": "string",
"sid": ["string"
]
}
]
}

4.地下埋設物照会業務

埋設物存否取得

指定した範囲内の埋設物有無を取得する。また、埋設物が存在する場合はその空間IDと事業者コードを取得する。

Request Body schema: application/json

request

targetArea	string 取得対象領域
sid	Array of strings 空間ID（配列）
existenceTime	string <date-time> 存在時間
datasetId	Array of strings データセットID（配列）

Responses

Request samples

Payload

Content type

application/json

{"targetArea": "string",
"sid": ["string"
],
"existenceTime": "2019-08-24T14:15:22Z",
"datasetId": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"isFacilityExist": true,
"datasetIdList": [{"datasetId": "string",
"companyCode": "string",
"sid": ["string"
]
}
]
}

埋設物属性情報取得

地下に存在する設備データの属性情報を取得する。

Request Body schema: application/json

request

sid required	string 空間ID
existenceTime	string <date-time> 存在時間
datasetId	Array of strings データセットID（配列）

Responses

Request samples

Payload

Content type

application/json

{"sid": "string",
"existenceTime": "2019-08-24T14:15:22Z",
"datasetId": ["string"
]
}

Response samples

200
400
500

Content type

application/json

{"datasetIdList": [{"datasetId": "string",
"companyCode": "string",
"contactInformation": "string",
"attributeList": [{"facilityClass": "string"
}
]
}
]
}