Page tree
Skip to end of metadata
Go to start of metadata

Digital.ai Continuous Testing (formerly Experitest) allows device reservations management using Rest API. The following are the supported Rest API's for managing device reservations.

The following Rest API's are supported for Cloud Admin and Project Admin only.

Following API is supported for all Type of roles

The role of the user performing the Rest Operation is specified by the 'Authorization' header.

Supports Authorization with Access Key only.

For more information please visit How To Execute Rest API, for a detailed example.

Get current and future reservations

Get the information of the current and future reservation.

GET /api/v1/device-reservations

Parameters

Name

Type

Mandatory

Description

start (BETA)

StringNoTime and date of the beginning of the interval - ISO 8601 format, UTC time (eg: "2019-04-04T18:51:44.940Z")
end (BETA)StringNoTime and date of the ending of the interval - ISO 8601 format, UTC time - (eg: "2019-04-05T18:51:44.940Z")
project StringNoThe project name - will return only reservations of devices for this project (Cloud Admin only)
deviceUidList<String>NoThe device uid (device unique identifier) - supports multiple values, will return only the reservations for these devices

username

StringNoThe user name - will return only the reservations of this user
Response
Response Status: 200 OK
{   
	"status": "SUCCESS",   
	"data" :[     
		{
			"reservationId": 3453,           
			"reservationStart": "2019-04-04T18:51:44.940+03:00",        
			"reservationEnd":   "2019-04-04T19:36:44.940+03:00",
			"ReservationNotes": "used for our regression testing",
			"user": "yotam123",
			"project": "ProjectA",
			"deviceUid: "23423sdf234o2i34",
			"deviceID": 523143
		},
		{
			"reservationId": 5453,           
			"reservationStart": "2019-04-04T19:00:00.000+03:00",        
			"reservationEnd":   "2019-04-04T21:00:00.000+03:00",
			"ReservationNotes": "",
			"user": "omer2",
			"project": "ProjectB",
			"deviceUid: "4kert235pojret09",
			"deviceID": 21231
		}
	]

    "code": "OK"
}


Remove current and future reservations

Current reservation - the device will be released from its current user.

Future reservation - the reservation will be deleted

DELETE /api/v1/device-reservations/{reservationId}

{reservationId} - id of the reservation


Response
Response Status: 200 OK
{
    "status": "SUCCESS",
    "code": "OK"
}


Add new reservation (current and future) for device 

Reserve device / devices.

POST /api/v1/device-reservations

Parameters

Name

Type

Mandatory

Description

deviceUidList of StringsYesThe device uid (device unique identifier) - supports multiple values, will reserve only the provided devices

reservationStart

StringYesTime and date of the beginning of the interval - ISO 8601 format, it can be with Default UTC time or with specific time-zone:
  1. UTC time format (Default) : 2021-02-24T19:00:00Z

  2. Timezone format : 2021-02-24T19:00:00+03:00 / 2021-02-24T19:00:00-03:00

reservationEndStringYesTime and date of the ending of the interval - ISO 8601 format, it can be with Default UTC time or with specific time-zone:
  1. UTC time format (Default) : 2021-02-24T19:00:00Z

  2. Timezone format : 2021-02-24T19:00:00+03:00 / 2021-02-24T19:00:00-03:00

usernameStringNoThe user name - will reserve a device for the current user or the user with the username if given
projectStringNoThe project name - if the reservation user has one project, the reservation project will be the user's project. Otherwise, the project name must be specified. (Cloud Admin only)

notes

StringNoThe reservation notes -  a reason for this reservation


Response
Response Status: 200 OK
{   
	"status": "SUCCESS",   
	"data" :[     
		{
			"message": "Reservation added successfully"
			"reservationId": 3453,
		    "deviceUid: "23423sdf234o2i34",
		
		},
		{
			"message": "Reservation added successfully"
			"reservationId": 4554,
		    "deviceUid: "ierw9823werwe30230",
		}
	]
    "code": "OK"
}


  • No labels