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>
227 lines
18 KiB
HTML
227 lines
18 KiB
HTML
<a name="rts_03_0052"></a><a name="rts_03_0052"></a>
|
|
|
|
<h1 class="topictitle1">Querying Software Configurations</h1>
|
|
<div id="body1511486474085"><div class="section" id="rts_03_0052__en-us_topic_0085081114_section5314816"><h4 class="sectiontitle">Function</h4><p id="rts_03_0052__en-us_topic_0085081114_p40918117">This API is used to query the software configurations.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section47833347"><h4 class="sectiontitle">URI</h4><p id="rts_03_0052__p76479013312">GET /v1/{project_id}/software_configs</p>
|
|
<p id="rts_03_0052__p2633957125312">For details about the parameters, see <a href="#rts_03_0052__table1759528275">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="rts_03_0052__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0052__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0052__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0052__p17762534144716"><strong id="rts_03_0052__b4428113023220">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_0052__p376433420478"><strong id="rts_03_0052__b1384431133219">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_0052__p15766123474714"><strong id="rts_03_0052__b15218143283211">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_0052__p147683349474"><strong id="rts_03_0052__b51816333325">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0052__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_0052__p0655184916104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0052__p865694971017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0052__p13658144921010">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section27846943"><h4 class="sectiontitle">Request Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0052__en-us_topic_0085081114_table2851385316" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0052__en-us_topic_0085081114_row711513185311"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.1"><p id="rts_03_0052__p13701251185014"><strong id="rts_03_0052__b167781640133212">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.6.1.2"><p id="rts_03_0052__p13704145119507"><strong id="rts_03_0052__b7665741103215">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.6.1.3"><p id="rts_03_0052__p3705151185017"><strong id="rts_03_0052__b5638134263212">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.6.1.4"><p id="rts_03_0052__p18709155145010"><strong id="rts_03_0052__b1901104314327">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.3.2.1.6.1.5"><p id="rts_03_0052__p1371214511507"><strong id="rts_03_0052__b177331244153210">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__en-us_topic_0085081114_row416813155310"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p81771311533">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0052__p1469622815313">query</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p318121325314">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p11194136535">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0052__en-us_topic_0085081114_p020141335320">Specifies the number of returned software configurations.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__en-us_topic_0085081114_row1120181355313"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p11215136536">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0052__p11696172815530">query</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p17221413115315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p1924313165320">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0052__en-us_topic_0085081114_p825413135312">Specifies the software configuration from which the next data record starts to be queried.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section49295902"><h4 class="sectiontitle">Response Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0052__table049473817172" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0052__row11494138141711"><th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0052__p173320367572"><strong id="rts_03_0052__b17546103093815">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0052__p335203620575"><strong id="rts_03_0052__b7456322382">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0052__p1037203619576"><strong id="rts_03_0052__b919123373813">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.18488151184882%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0052__p114113675711"><strong id="rts_03_0052__b124210341384">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__row1549443813176"><td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p86617813216">software_configs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0052__p1391819235614">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p8661283216">List <dict></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p76617810215">Specifies the software configuration objects.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="rts_03_0052__p109148261910"><strong id="rts_03_0052__b291113144012">software_configs</strong> structure information</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0052__en-us_topic_0085081114_table58541283" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0052__en-us_topic_0085081114_row14014710"><th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.4.1.5.1.1"><p id="rts_03_0052__p157111839115716"><strong id="rts_03_0052__b1790164104011">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.290000000000001%" id="mcps1.3.4.4.1.5.1.2"><p id="rts_03_0052__p20713113915716"><strong id="rts_03_0052__b720212515409">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.65%" id="mcps1.3.4.4.1.5.1.3"><p id="rts_03_0052__p1071618398570"><strong id="rts_03_0052__b12867694017">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.59%" id="mcps1.3.4.4.1.5.1.4"><p id="rts_03_0052__p4719203935710"><strong id="rts_03_0052__b11211794010">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__en-us_topic_0085081114_row20801079"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p12660188322">creation_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.290000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0052__p1516157165620">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p76601981927">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.59%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0052__p9523204141420">Specifies the creation time. The timestamp uses the ISO 8601 format:</p>
|
|
<pre class="screen" id="rts_03_0052__screen165994818143">CCYY-MM-DDThh:mm:ss±hh:mm</pre>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__en-us_topic_0085081114_row20715858"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p36601981521">group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.290000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0052__p1116157195616">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p1566068323">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.59%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p166604812220">Specifies the name of the software configuration group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__en-us_topic_0085081114_row26021030"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p66601181021">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.290000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0052__p19165710569">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p2066058624">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.59%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p1066088321">Specifies the software configuration UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__en-us_topic_0085081114_row45386595"><td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0052__en-us_topic_0085081114_p19660481229">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.290000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0052__p151667105613">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.65%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0052__en-us_topic_0085081114_p96601681328">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.59%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0052__en-us_topic_0085081114_p6661108424">Specifies the name of the software configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section41009935"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0052__screen1155462875317">GET /v1/95d02433133a4c0a87ba6967474a2ad3/software_configs</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section33545101"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0052__en-us_topic_0085081114_screen43751779113415">{
|
|
"software_configs": [
|
|
{
|
|
"group": "script",
|
|
"name": "a-config-we5zpvyu7b5o",
|
|
"creation_time": "2015-01-31T15:12:36Z",
|
|
"id": "ddee7aca-aa32-4335-8265-d436b20db4f1",
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0052__en-us_topic_0085081114_section33470456"><h4 class="sectiontitle">Return Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0052__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0052__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_0052__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0052__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_0052__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0052__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_0052__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0052__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__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_0052__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_0052__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_0052__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_0052__table1296574815364" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0052__rts_03_0025_row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0052__rts_03_0025_p129561510144"><strong id="rts_03_0052__rts_03_0025_b1552942884813">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_0052__rts_03_0025_p4959810444"><strong id="rts_03_0052__rts_03_0025_b956007905">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_0052__rts_03_0025_p9959161020418"><strong id="rts_03_0052__rts_03_0025_b359171417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0052__rts_03_0025_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0052__rts_03_0025_p896118101840">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0052__rts_03_0025_p1296211015416">Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0052__rts_03_0025_p9963110146">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__rts_03_0025_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0052__rts_03_0025_p18134027201912">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0052__rts_03_0025_p1713419274191">Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0052__rts_03_0025_p11134162718196">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__rts_03_0025_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0052__rts_03_0025_en-us_topic_0057973122_p5338333194217">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0052__rts_03_0025_p125520290312">Not found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0052__rts_03_0025_en-us_topic_0057973122_p29751790194217">The requested resources are not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0052__rts_03_0025_row196097477276"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0052__rts_03_0025_p19789174972712">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0052__rts_03_0025_p779364918272">Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0052__rts_03_0025_p196546319198">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0050.html">Software Configuration Management</a></div>
|
|
</div>
|
|
</div>
|
|
|