mir/vinyldns
2
0
Fork 0
mirror of https://github.com/VinylDNS/vinyldns synced 2025-08-31 14:25:30 +00:00
Code Issues Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Aravindh-Raju
2023-11-17 11:26:30 +05:30
parent 2279c6e008
commit 1f17a6b7be
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
modules/docs/src/main/mdoc/api/list-batchchanges.md
View File

@@ -12,7 +12,7 @@ The max number of batch changes that are returned from a single request has been
#### HTTP REQUEST
> GET zones/batchrecordchanges?startFrom={response.nextId}&maxItems={1-100}&ignoreAccess={true | false}&approvalStatus={batchChangeApprovalStatus}&userName={submitterUserName}
> GET zones/batchrecordchanges?startFrom={response.nextId}&maxItems={1-100}&ignoreAccess={true | false}&approvalStatus={batchChangeApprovalStatus}&userName={submitterUserName}&dateTimeRangeStart={dateTimeRangeStart}&dateTimeRangeEnd={dateTimeRangeEnd}
#### HTTP REQUEST PARAMS
@@ -23,6 +23,8 @@ maxItems | int | no | The number of items to return in t
ignoreAccess | boolean | no | 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 `false` if not provided. |
approvalStatus| BatchChangeApprovalStatus| no | Filter batch changes based on approval status. Can be one of **AutoApproved**, **PendingReview**, **ManuallyApproved**, **Rejected**, or **Cancelled**. |
userName | string | no | Filter batch changes based on submitter user name |
dateTimeRangeStart | string | no | Start date time value to filter batch changes based on date time range |
dateTimeRangeEnd | string | no | End date time value to filter batch changes based on date time range |
#### HTTP RESPONSE TYPES
@@ -44,6 +46,8 @@ maxItems | integer | `maxItems` sent in request, default is 100. |
ignoreAccess | boolean | `ignoreAccess` sent in request, default is `false`. |
approvalStatus | BatchChangeApprovalStatus | `approvalStatus` sent in request, will not be returned if not provided. |
userName | string | `userName` sent in request, will not be returned if not provided. |
dateTimeRangeStart | string | `dateTimeRangeStart` sent in request, will not be returned if not provided. |
dateTimeRangeEnd | string | `dateTimeRangeEnd` sent in request, will not be returned if not provided. |
##### BatchChangeSummary <a id="batchchangesummary-info" />