Represents information about the version of the configuration files
Since Product Version: 3.0
Resource URL
/webacs/api/v1/data/ConfigVersionsResponse 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 |
||||||||||||
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: |
||||||||||||
fileInfos |
List of configuration file info |
|||||||||||||
|
||||||||||||||
String |
instanceUuid |
This is a uuid for this instance. |
||||||||||||
boolean |
isFirst |
Indicates the first collected version of configuration files |
||||||||||||
boolean |
isLast |
Indicates the last 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://yerel-storm/webacs/api/v1/data/ConfigVersions/15
<?xml version="1.0" ?> <queryResponse type="ConfigVersions" responseType="getEntity" requestUrl="https://yerel-storm/webacs/api/v1/data/ConfigVersions/15" rootUrl="https://yerel-storm/webacs/api/v1/data"> <entity dtoType="configVersionsDTO" type="ConfigVersions" url="https://yerel-storm/webacs/api/v1/data/ConfigVersions/15"> <configVersionsDTO displayName="String value" id="15" uuid="String value"> <comments>String value</comments> <createdAt>2017-10-30T06:49:44.108+02:00</createdAt> <createdBy>String value</createdBy> <deviceIpAddress>String value</deviceIpAddress> <deviceName>String value</deviceName> <diffType>OUT_OF_SYNC</diffType> <fileInfos> <fileInfo> <fileId>2</fileId> <fileState>RUNNINGCONFIG</fileState> <fileType>BINARY</fileType> </fileInfo> </fileInfos> <isFirst>true</isFirst> <isLast>true</isLast> <outOfBand>true</outOfBand> <tags> <tag>String value</tag> </tags> </configVersionsDTO> </entity> </queryResponse>
Sample JSON Payload
https://yerel-storm/webacs/api/v1/data/ConfigVersions/15.json
{ "queryResponse" : { "@type" : "ConfigVersions", "@responseType" : "getEntity", "@requestUrl" : "https : \/\/yerel-storm\/webacs\/api\/v1\/data\/ConfigVersions\/15", "@rootUrl" : "https : \/\/yerel-storm\/webacs\/api\/v1\/data", "entity" : { "@dtoType" : "configVersionsDTO", "@type" : "ConfigVersions", "@url" : "https : \/\/yerel-storm\/webacs\/api\/v1\/data\/ConfigVersions\/15", "configVersionsDTO" : { "@displayName" : "String value", "@id" : "15", "@uuid" : "String value", "comments" : "String value", "createdAt" : "2017-10-30T06 : 49 : 44.108+02 : 00", "createdBy" : "String value", "deviceIpAddress" : "String value", "deviceName" : "String value", "diffType" : "OUT_OF_SYNC", "fileInfos" : { "fileInfo" : { "fileId" : 2, "fileState" : "RUNNINGCONFIG", "fileType" : "BINARY" } }, "isFirst" : true, "isLast" : true, "outOfBand" : true, "tags" : { "tag" : "String value" } } } } }