| Returns | Examples: | SUCCESSFUL: | {"success":1 ,"message":"Search successful", "data":{"meta":{"totalRecords":"3", "retrieved":3}, "0":{"id":"22", "resource_id1":"1292", "resource_id2":"1302", "relation":"dhcpPoolLink"}, "1":{"id":"2", "resource_id1":"1292", "resource_id2":"1452", "relation":"dhcpPoolLink"}, "2":{"id":"12", "resource_id1":"1422", "resource_id2":"1482", "relation":"dhcpPoolLink"}}} | | ERROR: | {"success":0, "message":"error message"} |
Return Detail: | Name | Type | Description |
|---|
| id | INTEGER | Id of the resource linkage | | resource_id1 | INTEGER | The id of the parent resource | | resource_id2 | INTEGER | The id of the linked resource | | relation | STRING | The relation type. Relation types include:
contact, dhcpPoolLink, dnsViewACL, dnsViewServer, dnsZoneMaster, dnsZoneServer, dnsZoneView |
Meta Attributes: | Name | Type | Description |
|---|
| totalRecords | INTEGER | How many records were found by this query, without pagination. | | retrieved | INTEGER | How many records were returned by this query, with pagination. |
Optional Attributes: | Name | Type | Description |
|---|
| resultsPerPage | INTEGER | How many records to include per page display.* | | page | INTEGER | Which page to display, when used with "resultsPerPage"* | | *Example pagination: api.php?target=resource&action=getLink&relation=dhcpPoolLink&resultsPerPage=100&page=2 |
|
