Configuration archive for device
Since Product Version: 3.0
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/ConfigArchives
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
deviceIpAddress
String
|
Device management address.
The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
deviceName
String
|
|
lastMessage
String
|
Contains error message, If last collection of configuration files was failed
|
lastSuccessful
boolean
|
Result of the last collection of configuration files
|
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/ConfigArchives/15
<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v1/data/ConfigArchives/15" rootUrl="https://localhost/webacs/api/v1/data">
<entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://localhost/webacs/api/v1/data/ConfigArchives/15">
<configArchivesDTO displayName="String value" id="15" uuid="String value">
<deviceName>String value</deviceName>
<lastMessage>String value</lastMessage>
<lastSuccessful>true</lastSuccessful>
<deviceIpAddress>String value</deviceIpAddress>
</configArchivesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v1/data/ConfigArchives/15.json
{
"queryResponse" : {
"@type" : "ConfigArchives",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ConfigArchives\/15",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "configArchivesDTO",
"@type" : "ConfigArchives",
"@url" : "https : \/\/localhost\/webacs\/api\/v1\/data\/ConfigArchives\/15",
"configArchivesDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"deviceName" : "String value",
"lastMessage" : "String value",
"lastSuccessful" : true,
"deviceIpAddress" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v2/data/ConfigArchives
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
deviceIpAddress
String
|
Device management address.
The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
deviceName
String
|
|
lastMessage
String
|
Contains error message, If last collection of configuration files was failed
|
lastSuccessful
boolean
|
Result of the last collection of configuration files
|
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/v2/data/ConfigArchives/15
<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v2/data/ConfigArchives/15" rootUrl="https://localhost/webacs/api/v2/data">
<entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://localhost/webacs/api/v2/data/ConfigArchives/15">
<configArchivesDTO displayName="String value" id="15" uuid="String value">
<deviceName>String value</deviceName>
<lastMessage>String value</lastMessage>
<lastSuccessful>true</lastSuccessful>
<deviceIpAddress>String value</deviceIpAddress>
</configArchivesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v2/data/ConfigArchives/15.json
{
"queryResponse" : {
"@type" : "ConfigArchives",
"@requestUrl" : "https://localhost/webacs/api/v2/data/ConfigArchives/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "configArchivesDTO",
"@type" : "ConfigArchives",
"@url" : "https://localhost/webacs/api/v2/data/ConfigArchives/15",
"configArchivesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"deviceIpAddress" : "String value",
"deviceName" : "String value",
"lastMessage" : "String value",
"lastSuccessful" : true
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v3/data/ConfigArchives
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
deviceIpAddress
String
|
Device management address.
The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
|
deviceName
String
|
|
lastMessage
String
|
Contains error message, If last collection of configuration files was failed
|
lastSuccessful
boolean
|
Result of the last collection of configuration files
|
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/v3/data/ConfigArchives/15
<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v3/data/ConfigArchives/15" rootUrl="https://localhost/webacs/api/v3/data">
<entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://localhost/webacs/api/v3/data/ConfigArchives/15">
<configArchivesDTO displayName="String value" id="15" uuid="String value">
<deviceName>String value</deviceName>
<lastMessage>String value</lastMessage>
<lastSuccessful>true</lastSuccessful>
<deviceIpAddress>String value</deviceIpAddress>
</configArchivesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v3/data/ConfigArchives/15.json
{
"queryResponse" : {
"@type" : "ConfigArchives",
"@requestUrl" : "https://localhost/webacs/api/v3/data/ConfigArchives/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "configArchivesDTO",
"@type" : "ConfigArchives",
"@url" : "https://localhost/webacs/api/v3/data/ConfigArchives/15",
"configArchivesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"deviceIpAddress" : "String value",
"deviceName" : "String value",
"lastMessage" : "String value",
"lastSuccessful" : true
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
No
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
DevNet Discussions
Resource URL
/webacs/api/v4/data/ConfigArchives
Updated
Since version 4 the deviceIpAddress attribute contains device IP address instead of device management address.
Response Parameters
deviceIpAddress
String
|
|
deviceName
String
|
|
lastMessage
String
|
Contains error message, If last collection of configuration files was failed
|
lastSuccessful
boolean
|
Result of the last collection of configuration files
|
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/v4/data/ConfigArchives/15
<?xml version="1.0" ?>
<queryResponse type="ConfigArchives" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/ConfigArchives/15" rootUrl="https://localhost/webacs/api/v4/data">
<entity dtoType="configArchivesDTO" type="ConfigArchives" url="https://localhost/webacs/api/v4/data/ConfigArchives/15">
<configArchivesDTO displayName="String value" id="15" uuid="String value">
<deviceName>String value</deviceName>
<lastMessage>String value</lastMessage>
<lastSuccessful>true</lastSuccessful>
<deviceIpAddress>String value</deviceIpAddress>
</configArchivesDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/data/ConfigArchives/15.json
{
"queryResponse" : {
"@type" : "ConfigArchives",
"@requestUrl" : "https://localhost/webacs/api/v4/data/ConfigArchives/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://localhost/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "configArchivesDTO",
"@type" : "ConfigArchives",
"@url" : "https://localhost/webacs/api/v4/data/ConfigArchives/15",
"configArchivesDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"deviceIpAddress" : "String value",
"deviceName" : "String value",
"lastMessage" : "String value",
"lastSuccessful" : true
}
} ]
}
}