Object Association Details - RESTful API

Summary:

List details of an association.

URL:

http(s)://{server hostname}/api/objects/{swID}/ associations /{associationName}

Methods summary

GET Method detail

Methods summary

• GET Method - displays details of an association.

GET Method detail

Displays details of an association. Association names are not case sensitive.

Response:

The list of items, with entries according to the following format:

Examples:

INPUT
curl -u admin:admin https://localhost/api/objects/655/associations/fans?media=json

OUTPUT
{
  "items": [
    {
      "objectId": 656,
      "typeName": "Fan",
      "displayName": "Fan 1",
      "displayType": "",
      "hasServiceStatus": true
    }, {
      "objectId": 657,
      "typeName": "Fan",
      "displayName": "Fan 2",
      "displayType": "",
      "hasServiceStatus": true
    }, {
      "objectId": 658,
      "typeName": "Fan",
      "displayName": "Fan 3",
      "displayType": "",
      "hasServiceStatus": true
    }
  ],
  "count": 3
}

INPUT
curl -u admin:admin https://localhost/api/objects/655/associations/fans?media=xml

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="3">
  <item xsi:type="associationInfo" hasServiceStatus="true" displayType="" displayName="Fan 1" typeName="Fan" objectId="656" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
  <item xsi:type="associationInfo" hasServiceStatus="true" displayType="" displayName="Fan 2" typeName="Fan" objectId="657" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
  <item xsi:type="associationInfo" hasServiceStatus="true" displayType="" displayName="Fan 3" typeName="Fan" objectId="658" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
</items>