Intended to bulk export of unsanitized configuration files from archive. This API resource does not support filtering and sorting on configuration files content.
Since Product Version: 3.1
Resource URL
/webacs/api/v1/data/BulkUnsanitizedConfigArchivesResponse Parameters
Type | Attribute Name | Description |
---|---|---|
String |
comments |
Comments from the system of configuration archive |
Date |
createdAt |
Date and time of creation |
String |
createdBy |
Initiator of creation |
long |
deviceId |
Unique identifier of device entity |
String |
deviceIpAddress |
Device IP address |
String |
deviceName |
Device host name |
ConfigVersionDiffEnum |
diffType |
The result of comparison with the previous version of the configuration files Allowed values:
|
files |
Configuration files |
|
String |
instanceUuid |
This is a uuid for this instance. |
boolean |
isFirst |
Indicates that current version is the first collected version of configuration files |
boolean |
isLast |
Indicates that current version is the latest collected version of configuration files |
boolean |
outOfBand |
The out-of-band change flag |
String[] |
tags |
User's tags for the version |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://172.25.123.114/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15
<?xml version="1.0" ?> <queryResponse type="BulkUnsanitizedConfigArchives" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15" rootUrl="https://172.25.123.114/webacs/api/v1/data"> <entity dtoType="bulkUnsanitizedConfigArchivesDTO" type="BulkUnsanitizedConfigArchives" url="https://172.25.123.114/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15"> <bulkUnsanitizedConfigArchivesDTO displayName="String value" id="15" uuid="String value"> <comments>String value</comments> <createdAt>2020-07-28T20:27:50.665Z</createdAt> <createdBy>String value</createdBy> <deviceId>2</deviceId> <deviceIpAddress>String value</deviceIpAddress> <deviceName>String value</deviceName> <diffType>OUT_OF_SYNC</diffType> <files> <file> <data>String value</data> <fileState>RUNNINGCONFIG</fileState> <fileType>BINARY</fileType> <instanceId>2</instanceId> </file> </files> <isFirst>true</isFirst> <isLast>true</isLast> <outOfBand>true</outOfBand> <tags> <tag>String value</tag> </tags> </bulkUnsanitizedConfigArchivesDTO> </entity> </queryResponse>
Sample JSON Payload
https://172.25.123.114/webacs/api/v1/data/BulkUnsanitizedConfigArchives/15.json
{ "queryResponse" : { "@type" : "BulkUnsanitizedConfigArchives", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/BulkUnsanitizedConfigArchives\/15", "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "bulkUnsanitizedConfigArchivesDTO", "@type" : "BulkUnsanitizedConfigArchives", "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/BulkUnsanitizedConfigArchives\/15", "bulkUnsanitizedConfigArchivesDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "comments" : "String value", "createdAt" : "2020-07-28T20 : 27 : 50.665Z", "createdBy" : "String value", "deviceId" : 2, "deviceIpAddress" : "String value", "deviceName" : "String value", "diffType" : "OUT_OF_SYNC", "files" : { "file" : { "data" : "String value", "fileState" : "RUNNINGCONFIG", "fileType" : "BINARY", "instanceId" : 2 } }, "isFirst" : true, "isLast" : true, "outOfBand" : true, "tags" : { "tag" : "String value" } } } } }