Inventory

Bulk link Inventory Items to Monitoring devices

Link each item_id to its hardware_id in one request. Entries whose item is inaccessible to the admin or whose hardware is already linked to another item are skipped — the response reports successful links in linked_count and the rejected item_ids in failed_ids. Entries dropped during input normalization (malformed or duplicate item_id) are counted in skipped_count. The invariant linked_count + len(failed_ids) + skipped_count == len(links) holds.

post/admin/inventory/items/link-hardware

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/inventory/items/link-hardware
  • Auth: HTTP basic

Request body

Example request

{
  "links": [
    {
      "item_id": 1,
      "hardware_id": 1
    }
  ]
}

Response

linked_countnumber

Number of pairs that were linked successfully.

failed_idsnumber[]

Inventory Item IDs that could not be linked: no admin access to the item, the target hardware is already linked elsewhere, or another save error.

skipped_countnumber

Number of input entries dropped during normalization (malformed entry or duplicate item_id). The invariant linked_count + len(failed_ids) + skipped_count == len(links) holds.

Example response

{
  "linked_count": 2,
  "failed_ids": [
    3
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.