Add device:mUnlink API action #60
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| code: true | ||
| type: page | ||
| title: mLink | ||
| description: Link multiple devices to multiple assets | ||
| --- | ||
|
|
||
| # mLink | ||
|
|
||
| Link multiple devices to multiple assets | ||
|
|
||
| --- | ||
|
|
||
| ## Query Syntax | ||
|
|
||
| ### HTTP | ||
|
|
||
| ``` http | ||
| URL: http://kuzzle:7512/_/device-manager/devices/_mLink[?refresh=wait_for][&strict] | ||
| Method: PUT | ||
| Body: | ||
| ``` | ||
|
|
||
| ``` js | ||
| { | ||
| // Using JSON | ||
| "records" [{ | ||
| "assetId": "myAssetId", | ||
| "deviceId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": "assetId, deviceId\nmyAssetId,test-id" | ||
| } | ||
| ``` | ||
|
|
||
| ### Other protocols | ||
|
|
||
| ``` js | ||
| { | ||
| "controller": "device-manager/device", | ||
| "action": "mLink", | ||
| "body": { | ||
| // Using JSON | ||
| "records" [{ | ||
| "assetId": "myAssetId", | ||
| "deviceId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": "assetId,deviceId\nmyAssetId,test-id", | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Body properties | ||
|
|
||
| Body properties, must contain at least one of the following: | ||
|
|
||
| - `records`: an array of objects, each containing an `assetId` and a `deviceId` properties | ||
| - `csv`: a csv syntax compatible containing at least this two headers `assetId,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 | ||
|
|
||
| ``` js | ||
| { | ||
| "status": 200, | ||
| "error": null, | ||
| "controller": "device-manager/device", | ||
| "action": "mLink", | ||
| "requestId": "<unique request identifier>", | ||
| "result": { | ||
| "errors": [], | ||
| "successes": [] | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| code: true | ||
| type: page | ||
| title: mUnlink | ||
| description: Unlink multiple devices from multiple assets | ||
| --- | ||
|
|
||
| # mUnlink | ||
|
|
||
| Unlink multiple devices from multiple assets | ||
|
|
||
| --- | ||
|
|
||
| ## Query Syntax | ||
|
|
||
| ### HTTP | ||
|
|
||
| ``` http | ||
| URL: http://kuzzle:7512/_/device-manager/devices/_mUnlink[?refresh=wait_for][&strict] | ||
| Method: PUT | ||
| Body: | ||
| ``` | ||
|
|
||
| ``` js | ||
| { | ||
| // Using JSON | ||
| "records" [{ | ||
| "deviceId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": " deviceId\ntest-id" | ||
| } | ||
| ``` | ||
|
|
||
| ### Other protocols | ||
|
|
||
| ``` js | ||
| { | ||
| "controller": "device-manager/device", | ||
| "action": "mUnlink", | ||
| "body": { | ||
| // Using JSON | ||
| "records" [{ | ||
| "deviceId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": "deviceId\ntest-id", | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Body properties | ||
|
|
||
| Body properties, must contain at least one of the following: | ||
|
|
||
| - `records`: an array of objects, each containing a `deviceId` properties | ||
| - `csv`: a csv syntax compatible containing at least this header `deviceId` with his 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 Unlink cannot be applied (e.g. devices that aren't attached to a tenant, or because of non-existing assets) | ||
|
|
||
| --- | ||
|
|
||
| ## Response | ||
|
|
||
| ``` js | ||
| { | ||
| "status": 200, | ||
| "error": null, | ||
| "controller": "device-manager/device", | ||
| "action": "mUnlink", | ||
| "requestId": "<unique request identifier>", | ||
| "result": { | ||
| "errors": [], | ||
| "successes": [] | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Boolean flag are true if set and false if not set, they can't have explicit value