Do not use this resource. Credentials can be retrieved through API Export Devices.
Operation to retrieve device credentials. Can take one of two parameters: 'id' or 'address'. , e.g. ?id=17010 or ?address=172.23.218.75, where the id is MEI ID or the address is the management address.
Since Product Version: 1.2
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Credential |
HTTP Methods |
GET |
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/op/cm/credentialsRequest Parameters
Attribute | Source | Description |
---|---|---|
id String |
query |
Optional Id is the MEI ID |
address String |
query |
Optional The management address. |
Response Parameters
Attribute | Description |
---|---|
The map of credentials. |
|
id String |
This corresponds to the IP_ADDRESS field in the underlying credential class. In XMP this holds the MEI ID. |
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 Response Payload
https://localhost/webacs/api/v1/op/cm/credentials
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v1/op/cm/credentials" rootUrl="https://localhost/webacs/api/v1/op">
<credentialDTO>
<credentialList>
<credentialList>
<lazyLoadedEntities>
<entry>
<key>String value</key>
<value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">String value</value>
</entry>
</lazyLoadedEntities>
<instanceId>2</instanceId>
<instanceUuid>String value</instanceUuid>
<instanceVersion>1</instanceVersion>
<propertyName>String value</propertyName>
<stringValue>String value</stringValue>
</credentialList>
</credentialList>
<id>String value</id>
</credentialDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v1/op/cm/credentials.json
{
"mgmtResponse" : {
"@responseType" : "operation",
"@requestUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op\/cm\/credentials",
"@rootUrl" : "https : \/\/localhost\/webacs\/api\/v1\/op",
"credentialDTO" : {
"credentialList" : {
"credentialList" : {
"lazyLoadedEntities" : {
"entry" : {
"key" : "String value",
"value" : {
"@xsi.type" : "xs : string",
"$" : "String value"
}
}
},
"instanceId" : 2,
"instanceUuid" : "String value",
"instanceVersion" : 1,
"propertyName" : "String value",
"stringValue" : "String value"
}
},
"id" : "String value"
}
}
}