Official Plugins (Kuzzle v2.x)
Device Manager v1.x
2

This plugin is part of the Kuzzle Enterprise Plan. If you are interested, please contact us.

mAttach #

Attach multiple devices to multiple tenants.

The device document will be duplicated inside the tenant "devices" collection.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/_/device-manager/devices/_mAttach[?refresh=wait_for][&strict]
Method: PUT
Body:
Copied to clipboard!
{
    // Using JSON
    "records" [{
        "tenantId": "tenant-kuzzle",
        "deviceId": "test-id"
    }],
    // Using CSV syntax
    "csv": "tenantId,deviceId\ntenant-kuzzle,test-id"
}

Other protocols #

Copied to clipboard!
{
    "controller": "device-manager/device",
    "action": "mAttach",
    "body": {
        // Using JSON
        "records" [{
            "tenantId": "tenant-kuzzle",
            "deviceId": "test-id"
        }],
        // Using CSV syntax
        "csv": "tenantId,deviceId\ntenant-kuzzle,test-id",
    }
}

Body properties #

Body properties, must contain at least one of

  • records: an array of object containing tenantId and deviceId
  • csv: a csv syntax compatible containing at least this two headers tenantId,deviceId with their corresponding values

Optional: #

  • refresh: if set to wait_for, Kuzzle will not respond until the documents are indexed
  • strict: (boolean) if set, makes the process fail preemptively if at least one link cannot be applied (e.g. devices that aren't attached to a tenant, or because of non-existing assets)

Response #

Copied to clipboard!
{
    "status": 200,
    "error": null,
    "controller": "device-manager/device",
    "action": "mAttach",
    "requestId": "<unique request identifier>",
    "result": {
        "errors": [],
        "successes": []
    }
}