forked from docs/doc-exports
334 lines
24 KiB
HTML
334 lines
24 KiB
HTML
<a name="UpdateTemplateMetadata"></a><a name="UpdateTemplateMetadata"></a>
|
|
|
|
<h1 class="topictitle1">Updating Template Metadata</h1>
|
|
<div id="body8662426"><div class="section" id="UpdateTemplateMetadata__section130185174410"><h4 class="sectiontitle">Function</h4><p id="UpdateTemplateMetadata__p61656449">UpdateTemplateMetadata</p>
|
|
<p id="UpdateTemplateMetadata__p6114504420">This API updates template metadata.</p>
|
|
<ul id="UpdateTemplateMetadata__ul1511058441"><li id="UpdateTemplateMetadata__li1314534419">This API only updates template description.</li></ul>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section823512446"><h4 class="sectiontitle">URI</h4><p id="UpdateTemplateMetadata__p10205134418">PATCH /v1/{project_id}/templates/{template_name}/metadata</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table103552442" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row9215534416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdateTemplateMetadata__p838514448">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdateTemplateMetadata__p13156443">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdateTemplateMetadata__p1312516444">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdateTemplateMetadata__p23256447">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row192558443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateTemplateMetadata__p1233554410">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateTemplateMetadata__p134165184415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateTemplateMetadata__p241053440">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateTemplateMetadata__p1943544418">Project ID. It can be obtained by calling an API or from the console.</p>
|
|
<p id="UpdateTemplateMetadata__p753512448">Minimum: <strong id="UpdateTemplateMetadata__b185355448">3</strong></p>
|
|
<p id="UpdateTemplateMetadata__p155856449">Maximum: <strong id="UpdateTemplateMetadata__b351853449">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row182205134412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdateTemplateMetadata__p55752447">template_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdateTemplateMetadata__p11555144414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdateTemplateMetadata__p1461059445">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdateTemplateMetadata__p963518441">Name of the template to be created.</p>
|
|
<p id="UpdateTemplateMetadata__p1667511441">Minimum: <strong id="UpdateTemplateMetadata__b176557449">1</strong></p>
|
|
<p id="UpdateTemplateMetadata__p13620594419">Maximum: <strong id="UpdateTemplateMetadata__b197954447">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section771154447"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__en-us_topic_0000001757038305_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row9715504415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdateTemplateMetadata__p1189514410">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdateTemplateMetadata__p2093520443">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdateTemplateMetadata__p9919515445">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdateTemplateMetadata__p159115174410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row178856447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdateTemplateMetadata__p149152442">Client-Request-Id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdateTemplateMetadata__p89956447">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdateTemplateMetadata__p510195114410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdateTemplateMetadata__p1810195194414">Unique request ID. It is specified by a user and is used to locate a request. UUID is recommended.</p>
|
|
<p id="UpdateTemplateMetadata__p15101952448">Minimum: <strong id="UpdateTemplateMetadata__b101014517442">36</strong></p>
|
|
<p id="UpdateTemplateMetadata__p191016534411">Maximum: <strong id="UpdateTemplateMetadata__b141011504413">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__en-us_topic_0000001757038305_request_UpdateTemplateMetadataRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row21014584419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateTemplateMetadata__p61118518440">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateTemplateMetadata__p71119514447">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateTemplateMetadata__p12111559441">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateTemplateMetadata__p311151440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row171019574411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateTemplateMetadata__p311655443">template_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateTemplateMetadata__p1412359441">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateTemplateMetadata__p912254448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateTemplateMetadata__p101213511446">Unique template ID. It is randomly generated by the template service.</p>
|
|
<p id="UpdateTemplateMetadata__p13121654449">Minimum: <strong id="UpdateTemplateMetadata__b812175184410">36</strong></p>
|
|
<p id="UpdateTemplateMetadata__p14126511440">Maximum: <strong id="UpdateTemplateMetadata__b112105184413">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row510452444"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateTemplateMetadata__p191313564415">template_description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateTemplateMetadata__p1013135104420">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateTemplateMetadata__p513050448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateTemplateMetadata__p513105104418">Template description. It can be used by users to identify their own templates.</p>
|
|
<p id="UpdateTemplateMetadata__p113165174417">Minimum: <strong id="UpdateTemplateMetadata__b2013154443">0</strong></p>
|
|
<p id="UpdateTemplateMetadata__p613659449">Maximum: <strong id="UpdateTemplateMetadata__b2141853448">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section18142544419"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateTemplateMetadata__p20147584418"><strong id="UpdateTemplateMetadata__b14146515447">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__en-us_topic_0000001757038305_response_ErrorRsp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row11141751447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdateTemplateMetadata__p11151544415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdateTemplateMetadata__p191514564416">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdateTemplateMetadata__p81513564411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row101420554413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateTemplateMetadata__p14151257445">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateTemplateMetadata__p19157594420">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateTemplateMetadata__p316758449">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row51519515442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdateTemplateMetadata__p171675124413">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdateTemplateMetadata__p91615134411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdateTemplateMetadata__p14161251445">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateTemplateMetadata__p14163512449"><strong id="UpdateTemplateMetadata__b1617135194412">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table19171951447" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row1174516449"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdateTemplateMetadata__p91775104417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdateTemplateMetadata__p121714511445">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdateTemplateMetadata__p171716514446">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row141713594415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateTemplateMetadata__p17182514413">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateTemplateMetadata__p12185584414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateTemplateMetadata__p1418105144416">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row10170514443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdateTemplateMetadata__p1418125184415">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdateTemplateMetadata__p41845204419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdateTemplateMetadata__p2184554410">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateTemplateMetadata__p9189594415"><strong id="UpdateTemplateMetadata__b0194524417">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table11191451447" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row1119125114419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdateTemplateMetadata__p51985144416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdateTemplateMetadata__p121919534418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdateTemplateMetadata__p8193515446">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row131995174412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateTemplateMetadata__p15208564420">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateTemplateMetadata__p720185194417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateTemplateMetadata__p182045144418">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row191995164415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdateTemplateMetadata__p19209594419">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdateTemplateMetadata__p3201554414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdateTemplateMetadata__p12025114411">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateTemplateMetadata__p1121125184414"><strong id="UpdateTemplateMetadata__b16211452441">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table42195104419" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row13213574420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="UpdateTemplateMetadata__p12224534418">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="UpdateTemplateMetadata__p18236504418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="UpdateTemplateMetadata__p172313584410">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row142110554411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="UpdateTemplateMetadata__p52315134418">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="UpdateTemplateMetadata__p152419512446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="UpdateTemplateMetadata__p5241456449">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row11211519448"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="UpdateTemplateMetadata__p524154445">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="UpdateTemplateMetadata__p1624105134417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="UpdateTemplateMetadata__p125554449">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateTemplateMetadata__p62518512444"><strong id="UpdateTemplateMetadata__b142518517448">Status code: 429</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table2025558443" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row4258514413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="UpdateTemplateMetadata__p11261956443">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="UpdateTemplateMetadata__p1326254447">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="UpdateTemplateMetadata__p42717514444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row12611512449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="UpdateTemplateMetadata__p6279516444">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="UpdateTemplateMetadata__p10271756448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="UpdateTemplateMetadata__p1827653444">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row12261584413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="UpdateTemplateMetadata__p12281752448">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="UpdateTemplateMetadata__p1287516444">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="UpdateTemplateMetadata__p1028153447">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="UpdateTemplateMetadata__p028752442"><strong id="UpdateTemplateMetadata__b82915574416">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__table132915513444" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="UpdateTemplateMetadata__row8291510446"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="UpdateTemplateMetadata__p43016574417">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="UpdateTemplateMetadata__p15301857441">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="UpdateTemplateMetadata__p13016511448">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row162955184415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="UpdateTemplateMetadata__p14319574411">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="UpdateTemplateMetadata__p1631135134414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="UpdateTemplateMetadata__p8311513443">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row122995154412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="UpdateTemplateMetadata__p832056448">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="UpdateTemplateMetadata__p10322564417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="UpdateTemplateMetadata__p1832952446">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section123315510447"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateTemplateMetadata__p633115204419">Update template metadata.</p>
|
|
<pre class="screen" id="UpdateTemplateMetadata__screen9348515449">PATCH https://{endpoint}/v1/c364070ab35041ddae68cf8b4839b60f/templates/my_template/metadata
|
|
|
|
{
|
|
"template_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
|
|
"template_description" : "my template description"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section183665144419"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateTemplateMetadata__p123619584414">None</p>
|
|
</div>
|
|
<div class="section" id="UpdateTemplateMetadata__section1336252449"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateTemplateMetadata__en-us_topic_0000001757038305_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateTemplateMetadata__row63715584418"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdateTemplateMetadata__p63820516440">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdateTemplateMetadata__p10381057444">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="UpdateTemplateMetadata__row737115124419"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p11381853440">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p18394514412">Template metadata updated. No data returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row133711516448"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p639175124416">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p133945134416">Invalid request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row20371455446"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p33911544418">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p114018594415">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row837175104411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p94085184414">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p2401059448">The user does not have the permission to call this API.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row18375511444"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p18405574413">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p164115519443">The template does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row1376517442"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p164125144413">429</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p154112514420">Too frequent requests.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="UpdateTemplateMetadata__row17374514445"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdateTemplateMetadata__p1642959449">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdateTemplateMetadata__p84255184419">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Template Management</a></div>
|
|
</div>
|
|
</div>
|
|
|