mirror of
https://github.com/VinylDNS/vinyldns
synced 2025-09-05 08:45:11 +00:00
227 lines
16 KiB
HTML
227 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 Governance" /><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 Governance" /><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 Governance" /><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-by-id.html" class="">Get Zone by ID</a></li> <li><a href="/api/get-zone-by-name.html" class="">Get Zone by Name</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> <ul class="sub_section"> <li><a href="/api/recordset-model.html" class="">RecordSet Model</a></li> <li><a href="/api/create-recordset.html" class="">Create RecordSet</a></li> <li><a href="/api/update-recordset.html" class="">Update RecordSet</a></li> <li><a href="/api/delete-recordset.html" class="">Delete RecordSet</a></li> <li><a href="/api/get-recordset.html" class="">Get RecordSet</a></li> <li><a href="/api/list-recordsets-by-zone.html" class="">List / Search RecordSets by Zone</a></li> <li><a href="/api/get-recordset-change.html" class="">Get RecordSet Change</a></li> <li><a href="/api/list-recordset-changes.html" class="">List RecordSet Changes</a></li> <li><a href="/api/list-recordsets-global.html" class="">Global List / Search RecordSets</a></li></ul></li> <li><a href="/api/batchchange-model.html" class="">Batch Change</a> <ul class="sub_section"> <li><a href="/api/batchchange-model.html" class="">Batch Change Model</a></li> <li><a href="/api/create-batchchange.html" class="">Create Batch Change</a></li> <li><a href="/api/get-batchchange.html" class="">Get Batch Change</a></li> <li><a href="/api/list-batchchanges.html" class=" active ">List Batch Changes</a></li> <li><a href="/api/batchchange-errors.html" class="">Batch Change Errors</a></li> <li><a href="/api/cancel-batchchange.html" class="">Cancel Batch Change</a></li> <li><a href="/api/approve-batchchange.html" class="">Approve Batch Change</a></li> <li><a href="/api/reject-batchchange.html" class="">Reject Batch Change</a></li></ul></li> <li><a href="/api/membership-model.html" class="">Membership</a> <ul class="sub_section"> <li><a href="/api/membership-model.html" class="">Membership Model</a></li> <li><a href="/api/create-group.html" class="">Create Group</a></li> <li><a href="/api/update-group.html" class="">Update Group</a></li> <li><a href="/api/delete-group.html" class="">Delete Group</a></li> <li><a href="/api/get-group.html" class="">Get Group</a></li> <li><a href="/api/list-groups.html" class="">List Groups</a></li> <li><a href="/api/list-group-admins.html" class="">List Group Admins</a></li> <li><a href="/api/list-group-members.html" class="">List Group Members</a></li> <li><a href="/api/list-group-activity.html" class="">List Group Activity</a></li></ul></li></ul></div><div id="page-content-wrapper"><div class="nav"><div class="container-fluid"><div class="row"><div class="col-lg-12"><div class="action-menu pull-left clearfix"><a href="#menu-toggle" id="menu-toggle"><i class="fa fa-bars" aria-hidden="true"></i></a></div><ul class="pull-right"><li id="gh-eyes-item" class="hidden-xs"><a href="https://github.com/VinylDNS/vinyldns"><i class="fa fa-eye"></i><span>WATCH<span id="eyes" class="label label-default">--</span></span></a></li><li id="gh-stars-item" class="hidden-xs"><a href="https://github.com/VinylDNS/vinyldns"><i class="fa fa-star-o"></i><span>STARS<span id="stars" class="label label-default">--</span></span></a></li></ul></div></div></div></div><div id="content" data-github-owner="VinylDNS" data-github-repo="vinyldns"><div class="content-wrapper"><section><h1 id="list-batch-changes">List Batch Changes</h1>
|
|
|
|
<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?startFrom={response.nextId}&maxItems={1-100}&ignoreAccess={true | false}&approval_status={BatchChangeApprovalStatus}</p>
|
|
</blockquote>
|
|
|
|
<h4 id="http-request-params">HTTP REQUEST PARAMS</h4>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>name</th>
|
|
<th>type</th>
|
|
<th>required?</th>
|
|
<th style="text-align: left">description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>startFrom</td>
|
|
<td>int</td>
|
|
<td>no</td>
|
|
<td style="text-align: left">In order to advance through pages of results, the startFrom is set to the <code class="highlighter-rouge">nextId</code> that is returned on the previous response. It is up to the client to maintain previous pages if the client wishes to advance forward and backward. If not specified, will return the first page of results.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maxItems</td>
|
|
<td>int</td>
|
|
<td>no</td>
|
|
<td style="text-align: left">The number of items to return in the page. Valid values are 1 - 100. Defaults to 100 if not provided.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ignoreAccess</td>
|
|
<td>boolean</td>
|
|
<td>no</td>
|
|
<td style="text-align: left">Flag determining whether to retrieve only batch changes made by calling user or to retrieve all changes. Only affects system administrators (ie. support and super users). Defaults to <code class="highlighter-rouge">false</code> if not provided.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>approvalStatus</td>
|
|
<td>BatchChangeApprovalStatus</td>
|
|
<td>no</td>
|
|
<td style="text-align: left">Filter batch changes based on approval status. Can be one of <strong>AutoApproved</strong>, <strong>PendingReview</strong>, <strong>ManuallyApproved</strong>, <strong>Rejected</strong>, or <strong>Cancelled</strong>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<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>
|
|
<tr>
|
|
<td>startFrom</td>
|
|
<td style="text-align: left">int</td>
|
|
<td style="text-align: left"><code class="highlighter-rouge">startFrom</code> sent in request, will not be returned if not provided.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>nextId</td>
|
|
<td style="text-align: left">int</td>
|
|
<td style="text-align: left"><code class="highlighter-rouge">startFrom</code> parameter of next page request, will not be returned if record sets are exhausted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maxItems</td>
|
|
<td style="text-align: left">integer</td>
|
|
<td style="text-align: left"><code class="highlighter-rouge">maxItems</code> sent in request, default is 100.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>ignoreAccess</td>
|
|
<td style="text-align: left">boolean</td>
|
|
<td style="text-align: left"><code class="highlighter-rouge">ignoreAccess</code> sent in request, default is <code class="highlighter-rouge">false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>approvalStatus</td>
|
|
<td style="text-align: left">BatchChangeApprovalStatus</td>
|
|
<td style="text-align: left"><code class="highlighter-rouge">approvalStatus</code> sent in request, will not be returned if not provided.</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">string</td>
|
|
<td style="text-align: left">Conditional: comments about the batch change, if provided.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>createdTimestamp</td>
|
|
<td style="text-align: left">date-time</td>
|
|
<td style="text-align: left">The timestamp (UTC) 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"><a href="../api/batchchange-model#batchchange-attributes">Status of the batch change</a>.</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>ownerGroupName</td>
|
|
<td style="text-align: left">string</td>
|
|
<td style="text-align: left">Conditional: Record ownership assignment, if provided.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>approvalStatus</td>
|
|
<td style="text-align: left">BatchChangeApprovalStatus</td>
|
|
<td style="text-align: left">Whether the batch change is currently awaiting manual review. Can be one of <strong>AutoApproved</strong>, <strong>PendingReview</strong>, <strong>ManuallyApproved</strong>, <strong>Rejected</strong>, or <strong>Cancelled</strong>.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h4 id="example-response">EXAMPLE RESPONSE</h4>
|
|
|
|
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>{
|
|
"batchChanges": [
|
|
{
|
|
"userId": "vinyl",
|
|
"userName": "vinyl201",
|
|
"comments": "this is optional",
|
|
"createdTimestamp": "2018-05-11T18:12:13Z",
|
|
"totalChanges": 5,
|
|
"status": "Complete",
|
|
"id": "bd03175c-6fd7-419e-991c-3d5d1441d995",
|
|
"ownerGroupId": "f42385e4-5675-38c0-b42f-64105e743bfe",
|
|
"ownerGroupName": "some owner group name",
|
|
"approvalStatus": "AutoApproved"
|
|
},
|
|
{
|
|
"userId": "vinyl",
|
|
"userName": "vinyl201",
|
|
"comments": "this is optional",
|
|
"createdTimestamp": "2018-05-11T18:12:12Z",
|
|
"totalChanges": 10,
|
|
"status": "Complete",
|
|
"id": "743cbd16-5440-4cf7-bca9-20319df9b651",
|
|
"ownerGroupId": "f42385e4-5675-38c0-b42f-64105e743bfe",
|
|
"ownerGroupName": "some owner group name",
|
|
"approvalStatus": "ManuallyApproved"
|
|
},
|
|
{
|
|
"userId": "vinyl",
|
|
"userName": "vinyl201",
|
|
"comments": "this is optional",
|
|
"createdTimestamp": "2018-05-11T18:12:12Z",
|
|
"totalChanges": 7,
|
|
"status": "Complete",
|
|
"id": "2b827a33-7c4f-4623-8dd9-277c6fba0e54",
|
|
"approvalStatus": "Rejected",
|
|
"reviewerId": "270ba4b3-f5eb-4043-a283-1a6cec0993f3",
|
|
"reviewerName": "some reviewer",
|
|
"reviewTimestamp": "2018-05-13T13:12:10Z"
|
|
}
|
|
],
|
|
"maxItems": 100,
|
|
"ignoreAccess": false
|
|
}
|
|
</code></pre></div></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> |