mirror of
https://github.com/VinylDNS/vinyldns
synced 2025-09-05 16:55:16 +00:00
148 lines
16 KiB
HTML
148 lines
16 KiB
HTML
|
<html><head><title>VinylDNS: List Batch Changes</title><meta charset="utf-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="VinylDNS" /><meta name="description" content="DNS Management Platform" /><meta name="og:image" content="/img/poster.png" /><meta name="og:title" content="VinylDNS: List Batch Changes" /><meta name="og:site_name" content="VinylDNS" /><meta name="og:url" content="http://vinyldns.io" /><meta name="og:type" content="website" /><meta name="og:description" content="DNS Management Platform" /><link rel="icon" type="image/png" href="/img/favicon.png" /><meta name="twitter:title" content="VinylDNS: List Batch Changes" /><meta name="twitter:image" content="http://vinyldns.ioimg/poster.png" /><meta name="twitter:description" content="DNS Management Platform" /><meta name="twitter:card" content="summary_large_image" /><link rel="icon" type="image/png" sizes="16x16" href="/img/favicon16x16.png" /><link rel="icon" type="image/png" sizes="24x24" href="/img/favicon24x24.png" /><link rel="icon" type="image/png" sizes="32x32" href="/img/favicon32x32.png" /><link rel="icon" type="image/png" sizes="48x48" href="/img/favicon48x48.png" /><link rel="icon" type="image/png" sizes="57x57" href="/img/favicon57x57.png" /><link rel="icon" type="image/png" sizes="60x60" href="/img/favicon60x60.png" /><link rel="icon" type="image/png" sizes="64x64" href="/img/favicon64x64.png" /><link rel="icon" type="image/png" sizes="70x70" href="/img/favicon70x70.png" /><link rel="icon" type="image/png" sizes="72x72" href="/img/favicon72x72.png" /><link rel="icon" type="image/png" sizes="76x76" href="/img/favicon76x76.png" /><link rel="icon" type="image/png" sizes="96x96" href="/img/favicon96x96.png" /><link rel="icon" type="image/png" sizes="114x114" href="/img/favicon114x114.png" /><link rel="icon" type="image/png" sizes="120x120" href="/img/favicon120x120.png" /><link rel="icon" type="image/png" sizes="128x128" href="/img/favicon128x128.png" /><link rel="icon" type="image/png" sizes="144x144" href="/img/favicon144x144.png" /><link rel="icon" type="image/png" sizes="150x150" href="/img/favicon150x150.png" /><link rel="icon" type="image/png" sizes="152x152" href="/img/favicon152x152.png" /><link rel="icon" type="image/png" sizes="196x196" href="/img/favicon196x196.png" /><link rel="icon" type="image/png" sizes="310x310" href="/img/favicon310x310.png" /><link rel="icon" type="image/png" sizes="310x150" href="/img/favicon310x150.png" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" /><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" /><link rel="stylesheet" href="/highlight/styles/default.css" /><link rel="stylesheet" href="/css/style.css" /><link rel="stylesheet" href="/css/palette.css" /><link rel="stylesheet" href="/css/codemirror.css" /><link rel="stylesheet" href="/css/custom.css" /></head><body class="docs"><div id="wrapper"><div id="sidebar-wrapper"><ul id="sidebar" class="sidebar-nav"><li class="sidebar-brand"><a href="/" class="brand"><div class="brand-wrapper"><span>VinylDNS</span></div></a></li> <li><a href="/api/index" class="">API documentation</a></li> <li><a href="/api/auth-mechanism.html" class="">Authentication</a></li> <li><a href="/api/zone-model.html" class="">Zone</a> <ul class="sub_section"> <li><a href="/api/zone-model.html" class="">Zone Model</a></li> <li><a href="/api/create-zone.html" class="">Create Zone</a></li> <li><a href="/api/update-zone.html" class="">Update Zone</a></li> <li><a href="/api/delete-zone.html" class="">Delete Zone</a></li> <li><a href="/api/get-zone.html" class="">Get Zone</a></li> <li><a href="/api/list-zones.html" class="">List / Search Zone</a></li> <li><a href="/api/sync-zone.html" class="">Sync Zone</a></li> <li><a href="/api/list-zone-changes.html" class="">List Zone Changes</a></li></ul></li> <li><a href="/api/recordset-model.html" class="">RecordSet</a>
|
||
|
|
|
||
|
|
<p>Retrieves the most recent 100 batch changes created by the user. This call will return a subset of the full information in each change, as detailed in the <a href="#response-attributes">attributes section</a>.</p>
|
||
|
|
|
||
|
|
<p>The max number of batch changes that are returned from a single request has been set to 100.</p>
|
||
|
|
|
||
|
|
<h4 id="http-request">HTTP REQUEST</h4>
|
||
|
|
|
||
|
|
<blockquote>
|
||
|
|
<p>GET zones/batchrecordchanges</p>
|
||
|
|
</blockquote>
|
||
|
|
|
||
|
|
<h4 id="http-response-types">HTTP RESPONSE TYPES</h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Code</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>200</td>
|
||
|
|
<td style="text-align: left"><strong>OK</strong> - the batch change is returned in response body.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>403</td>
|
||
|
|
<td style="text-align: left"><strong>Forbidden</strong> - the user does not have the access required to perform the action.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>If there are no batch changes created by the user, a successful empty response body is returned.</p>
|
||
|
|
|
||
|
|
<h4 id="http-response-attributes-">HTTP RESPONSE ATTRIBUTES <a id="response-attributes"></a></h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>batchChanges</td>
|
||
|
|
<td style="text-align: left">Array of <a href="#batchchangesummary-info">BatchChangeSummary</a></td>
|
||
|
|
<td style="text-align: left">Summary information for the most recent 100 batch changes created by the user.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5 id="batchchangesummary-">BatchChangeSummary <a id="batchchangesummary-info"></a></h5>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>userId</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The unique identifier of the user that created the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>userName</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The username of the user that created the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>comments</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">Optional comments about the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>createdTimestamp</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td style="text-align: left">The timestamp (in GMT) when the batch change was created.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>totalChanges</td>
|
||
|
|
<td style="text-align: left">int</td>
|
||
|
|
<td style="text-align: left">The total number of single changes within the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>status</td>
|
||
|
|
<td style="text-align: left">BatchChangeStatus</td>
|
||
|
|
<td style="text-align: left"><strong>Pending</strong> - at least one change in batch in still in pending state; <strong>Complete</strong> - all changes are in complete state; <strong>Failed</strong> - all changes are in failure state; <strong>PartialFailure</strong> - some changes have failed and the rest are complete.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>id</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">The unique identifier for this batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>ownerGroupId</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td style="text-align: left">Record ownership assignment. Required if any records in the batch change are in <a href="../api/zone-model#shared-zones">shared zones</a> and are new or unowned.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h4 id="example-response">EXAMPLE RESPONSE</h4>
|
||
|
|
|
||
|
|
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"batchChanges"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"userId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"userName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl201"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"createdTimestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-05-11T18:12:13Z"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"totalChanges"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Complete"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bd03175c-6fd7-419e-991c-3d5d1441d995"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"ownerGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f42385e4-5675-38c0-b42f-64105e743bfe"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"userId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"userName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl201"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"createdTimestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-05-11T18:12:12Z"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"totalChanges"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Complete"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"c2ad84b0-e6de-4a70-aa28-e808d33deaa5"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nt">"userId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"userName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl201"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"createdTimestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-05-11T18:12:12Z"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"totalChanges"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Complete"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2b827a33-7c4f-4623-8dd9-277c6fba0e54"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">]</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span></code></pre>
|
||
|
|
</div>
|
||
|
|
</section><div class="edit-button"><a href="https://github.com/VinylDNS/vinyldns/edit/master/modules/docs/src/main/tut/api/list-batchchanges.md" class="btn-sm btn-info">Improve this page</a></div></div></div></div></div><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script><script src="/highlight/highlight.pack.js"></script><script>hljs.configure({languages:['scala','java','bash']});
|
||
|
|
hljs.initHighlighting();
|
||
|
|
</script><script>((window.gitter = {}).chat = {}).options = {
|
||
|
|
room: 'vinyldns/Lobby'};</script><script src="https://sidecar.gitter.im/dist/sidecar.v1.js"></script><script src="/js/main.js"></script></body></html>
|