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_0018"></a><a name="rts_03_0018"></a>
|
|
|
|
<h1 class="topictitle1">Querying API Versions</h1>
|
|
<div id="body1511161465560"><div class="section" id="rts_03_0018__en-us_topic_0057973117_section21216187"><h4 class="sectiontitle">Function</h4><p id="rts_03_0018__en-us_topic_0057973117_p56261263">This API is used to query all available versions.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section56727960"><h4 class="sectiontitle">URI</h4><p id="rts_03_0018__p5277102611257">GET /</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section40789600"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0018__en-us_topic_0057973117_p53782341">N/A</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section31562082"><h4 class="sectiontitle">Response Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0018__table15493522192814" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0018__row54931122132812"><th align="left" class="cellrowborder" valign="top" width="17.648235176482352%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0018__p17493122142817"><strong id="rts_03_0018__b1478562243010">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.46835316468353%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0018__p1887419221879"><strong id="rts_03_0018__b24485441227">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.648235176482352%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0018__p16493922112813"><strong id="rts_03_0018__b84235270615453">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.23517648235177%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0018__p1549342213284"><strong id="rts_03_0018__b12999639183115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0018__row64931422142810"><td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0018__p76822021112914">versions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46835316468353%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0018__p148751022374">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0018__p9561131172615">List <dict></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23517648235177%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0018__p645919381634">Specifies the API version list.</p>
|
|
<p id="rts_03_0018__p15682182116296">Each object in the list provides API version information, such as the ID, status, and links.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rts_03_0018__p061563465615"><strong id="rts_03_0018__b03871419183311">versions</strong> structure information</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0018__table882418307561" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0018__row118281430125619"><th align="left" class="cellrowborder" valign="top" width="17.648235176482352%" id="mcps1.3.4.4.1.5.1.1"><p id="rts_03_0018__p1420873193710"><strong id="rts_03_0018__b249043013338">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.46835316468353%" id="mcps1.3.4.4.1.5.1.2"><p id="rts_03_0018__p720973113716"><strong id="rts_03_0018__b13209191816314">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.648235176482352%" id="mcps1.3.4.4.1.5.1.3"><p id="rts_03_0018__p1520953116376"><strong id="rts_03_0018__b157070521337">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.23517648235177%" id="mcps1.3.4.4.1.5.1.4"><p id="rts_03_0018__p9212231153715"><strong id="rts_03_0018__b916516550339">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0018__row4838430145613"><td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0018__p118381330105611">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46835316468353%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0018__p162781213816">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0018__p3841113085610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23517648235177%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0018__p984316306564">Specifies the API version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0018__row19843183045616"><td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0018__p28455302565">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46835316468353%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0018__p3278111688">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0018__p10847153075618">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23517648235177%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0018__p9850133035618">Specifies the API version status. Available values are as follows:</p>
|
|
<ul id="rts_03_0018__ul385183011569"><li id="rts_03_0018__li58511530145619"><strong id="rts_03_0018__b842352706235943">CURRENT</strong>: preferred API version</li><li id="rts_03_0018__li19851103015567"><strong id="rts_03_0018__b1579833714369">SUPPORTED</strong>: an earlier API version, which is still in use</li><li id="rts_03_0018__li7852030115617"><strong id="rts_03_0018__b76883013373">DEPRECATED</strong>: an obsolete API version to be deleted</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0018__row17854183055617"><td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0018__p985413304568">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.46835316468353%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0018__p1027801680">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.648235176482352%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0018__p10854103045620">List <dict></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.23517648235177%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0018__p10399164310311">Specifies the API URL list.</p>
|
|
<p id="rts_03_0018__p158561830155616">Each URL is a JSON object with one <strong id="rts_03_0018__b14306447115011">href</strong> keyword for identifying the URL and one <strong id="rts_03_0018__b189711551175018">rel</strong> keyword indicating the relationship between the API version and the involved stack.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section15623289"><h4 class="sectiontitle">Request Example</h4><p id="rts_03_0018__en-us_topic_0057973117_p7534554">None</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section6391877"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0018__en-us_topic_0057973117_screen6637676711011">{
|
|
"versions": [
|
|
{
|
|
"status": "CURRENT",
|
|
"id": "v1.0",
|
|
"links": [
|
|
{
|
|
"href": "http://x.x.x.x:8774/v1/",
|
|
"rel": "self"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0018__en-us_topic_0057973117_section57526895"><h4 class="sectiontitle">Return Code</h4><p id="rts_03_0018__p43826129287">The following code will be returned if the system is operating normally.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0018__en-us_topic_0057973117_table40445519194057" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0018__en-us_topic_0057973117_row42419326194057"><th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.7.3.1.4.1.1"><p id="rts_03_0018__en-us_topic_0057973117_p13413377194057">Return Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.7.3.1.4.1.2"><p id="rts_03_0018__en-us_topic_0057973117_p12741761194057">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.08%" id="mcps1.3.7.3.1.4.1.3"><p id="rts_03_0018__en-us_topic_0057973117_p25449701194057">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0018__en-us_topic_0057973117_row48159894194057"><td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.7.3.1.4.1.1 "><p id="rts_03_0018__en-us_topic_0057973117_p8637307194057">300</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.7.3.1.4.1.2 "><p id="rts_03_0018__en-us_topic_0057973117_p28533244194057">Multiple choices</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.08%" headers="mcps1.3.7.3.1.4.1.3 "><p id="rts_03_0018__en-us_topic_0057973117_p29491459194057">The requested resource has multiple available responses.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0017.html">API Version Management</a></div>
|
|
</div>
|
|
</div>
|
|
|