forked from docs/doc-exports
Hasko, Vladimir
354bef10dd
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
124 lines
9.1 KiB
HTML
124 lines
9.1 KiB
HTML
<a name="rts_03_0049"></a><a name="rts_03_0049"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Building Information</h1>
|
|
<div id="body1511161465561"><div class="section" id="rts_03_0049__en-us_topic_0057973151_section36500993"><h4 class="sectiontitle">Function</h4><p id="rts_03_0049__en-us_topic_0057973151_p53758695">This API is used to query the building information.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section60073487"><h4 class="sectiontitle">URI</h4><p id="rts_03_0049__p76479013312">GET /v1/{project_id}/build_info</p>
|
|
<p id="rts_03_0049__p0553643112619">For details about the parameters, see <a href="#rts_03_0049__table1759528275">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="rts_03_0049__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0049__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0049__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0049__p17762534144716"><strong id="rts_03_0049__b33553211349">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.2"><p id="rts_03_0049__p376433420478"><strong id="rts_03_0049__b9409142213417">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.3"><p id="rts_03_0049__p15766123474714"><strong id="rts_03_0049__b72321323153410">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.4"><p id="rts_03_0049__p147683349474"><strong id="rts_03_0049__b19371124173410">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0049__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0049__p1765464961019">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0049__p0655184916104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0049__p865694971017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0049__p13658144921010">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section3790475"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0049__p156343117595">N/A</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section34114278"><h4 class="sectiontitle">Response Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0049__en-us_topic_0057973151_table63619552" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0049__en-us_topic_0057973151_row33690117"><th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0049__p13701251185014"><strong id="rts_03_0049__b9346153311342">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0049__p13704145119507"><strong id="rts_03_0049__b4415434133414">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.65%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0049__p3705151185017"><strong id="rts_03_0049__b17332203503416">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.41%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0049__p1371214511507"><strong id="rts_03_0049__b11218183613344">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0049__en-us_topic_0057973151_row50452473"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0049__en-us_topic_0057973151_p60118549">api</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0049__p87428544215">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0049__en-us_topic_0057973151_p37764268">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.41%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0049__en-us_topic_0057973151_p5441393">Specifies the API information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0049__en-us_topic_0057973151_row48972542"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0049__en-us_topic_0057973151_p7352932">engine</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0049__p177421853423">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0049__en-us_topic_0057973151_p58716619">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.41%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0049__en-us_topic_0057973151_p34860474">Specifies the engine information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section38593049"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0049__en-us_topic_0057973149_screen56758950">GET /v1/95d02433133a4c0a87ba6967474a2ad3/build_info</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section11793125"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0049__en-us_topic_0057973151_screen6262734113046">{
|
|
"api": {
|
|
"revision": "{api_build_revision}"
|
|
},
|
|
"engine": {
|
|
"revision": "{engine_build_revision}"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0049__en-us_topic_0057973151_section39029268"><h4 class="sectiontitle"><strong id="rts_03_0049__b780206103513">Return Code</strong></h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0049__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_row42419326194057"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.2.2.4.1.1"><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0049__rts_03_0020_b14910172512114">Return Code</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.7.2.2.4.1.2"><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0049__rts_03_0020_en-us_topic_0057973140_b84235270615814_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.7.2.2.4.1.3"><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0049__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_row48159894194057"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.2.4.1.1 "><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p8637307194057">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.2.2.4.1.2 "><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p28533244194057">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.2.2.4.1.3 "><p id="rts_03_0049__rts_03_0020_en-us_topic_0057973117_p29491459194057">Request was successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0049__table19512103414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0049__row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0049__p129561510144"><strong id="rts_03_0049__b1754611012356">Return Code</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.7.3.2.4.1.2"><p id="rts_03_0049__p4959810444"><strong id="rts_03_0049__b14523141133514">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.7.3.2.4.1.3"><p id="rts_03_0049__p9959161020418"><strong id="rts_03_0049__b17343131218354">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0049__row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0049__p18134027201912">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0049__p1713419274191">Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0049__p11134162718196">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0048.html">Building Information</a></div>
|
|
</div>
|
|
</div>
|
|
|