Request Device by Requirements

Note: See the API documentation for this endpoint for more information. For general webmate API usage, see REST API .

Requests the deployment of a device in the project with the project ID specified, given a set of capabilities.


Endpoint	`/projects/{projectId}/device/devices`
Method	POST
projectId	Id of the project for which the device should be requested
Body	`{"name": "string","deviceRequirements": {}}`
return schema	JSON with device properties
return example	`{"id": "1018b7b9-6572-4908-b18b-d462d5343d76", ... }`

You can use this endpoint the following way:

curl -X POST "https://api.webmate.io/v1/projects/7c4f09fd-xxx-xxx-xxx-xxx/device/devices" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "webmate.api-token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=" \
-d '{"name":"exampleName","deviceRequirements":{"machine.platformName":"WINDOWS_11_64"}}'

You need an authenticated webmateSession to call this function, see this article on how to set up and authenticate with the SDK.

Parameter
projectId	webmate project id of the project for which the device should be requested
deviceRequest	webmate device request for the device that should be requested
platform	webmate Platform for the device that should be requested

Platform platform = new Platform(PlatformType.WINDOWS, "11", "64");
DeviceDTO device = webmateSession.device.requestDeviceByRequirements(new ProjectId(UUID.fromString("7c4f09fd-xxx-xxx-xxx-xxx")),
    new DeviceRequest("exampleName",
        new DeviceRequirements(ImmutableMap.of(DevicePropertyName.Platform, platform.toString()))));

You need an authenticated webmateSession to call this function, see this article on how to set up and authenticate with the SDK.

Parameter
projectId	webmate project id of the project for which the device should be requested
deviceRequest	webmate device request for the device that should be requested

let platform = new Platform(PlatformType.WINDOWS, "11", "64");
let deviceRequirements = new Map([['machine.platform', platform.toString()]]);
let deviceRequest = new DeviceRequest("exampleName", deviceRequirements);
let device = await webmateSession.device.requestDeviceByRequirements("7c4f09fd-xxx-xxx-xxx-xxx", deviceRequest).toPromise();