Represents information about the version of the configuration files
Since Product Version: 3.0
Resource Information
Rate Limiting? |
Yes |
Sorting? |
Yes |
Paging? |
Yes |
Filtering? |
Yes |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Read |
HTTP Methods |
GET |
DevNet Discussions
Resource URL
/webacs/api/v1/data/ConfigVersionsResponse Parameters
Attribute | Description |
---|---|
comments String |
Comments from the system of configuration archive |
createdAt Date |
Date and time of creation |
createdBy String |
Initiator of creation |
deviceIpAddress String |
Device IP address |
deviceName String |
Device host name |
diffType ConfigVersionDiffEnum |
The result of comparison with the previous version of the configuration files Allowed values: |
displayName String |
This is the displayName for this instance. |
List of configuration file info |
|
instanceUuid String |
This is a uuid for this instance. |
isFirst boolean |
Indicates the first collected version of configuration files |
isLast boolean |
Indicates the last collected version of configuration files |
outOfBand boolean |
The out-of-band change flag |
tags String[] |
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://localhost/webacs/api/v1/data/ConfigVersions/15
<?xml version="1.0" ?>
<queryResponse type="ConfigVersions" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/ConfigVersions/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="configVersionsDTO" type="ConfigVersions" url="https://localhost/webacs/api/v1/data/ConfigVersions/15">
<configVersionsDTO displayName="String value" id="15" uuid="String value">
<comments>String value</comments>
<createdAt>2017-07-13T13:21:09.172-07: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://localhost/webacs/api/v1/data/ConfigVersions/15.json
{
"queryResponse" : {
"@type" : "ConfigVersions",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ConfigVersions\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "configVersionsDTO",
"@type" : "ConfigVersions",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ConfigVersions\/15",
"configVersionsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"comments" : "String value",
"createdAt" : "2017-07-13T13 : 21 : 09.172-07 : 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"
}
}
}
}
}