Allows you to search for lab instances.
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
The value you want to sort by. If not supplied, a default value of "StartTime DESC" will be assumed. You can append " DESC" after the sort value to sort descending. For example, "StartTime DESC" would sort by when the lab instance was started in descending order. Possible values:
- StartTime
- EndTime
- LastName
- Lab
- TotalRunTime
An optional parameter used to filter for lab instances run by a particular user
An optional parameter used to filter for lab instances for a particular user using an external identifier
An optional parameter used to filter for instances of a particular lab
An optional parameter used to filter for lab instances launched from a particular course
An optional parameter used to filter for lab instances launched from a particular class
An optional parameter used to filter for lab instances launched from a particular class. Usually a unique identifier from the calling system.
Filters for lab instances with a particular completion status. Possible values:
- 0 = Cancelled
- 10 = In progress
- 20 = Complete
- 30 = Error
An optional parameter used to filter for lab instances started after a specified date. When used in conjunction with the "startedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for lab instances started before a specified date. When used in conjunction with the "startedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for lab instances ended after a specified date. When used in conjunction with the "endedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for lab instances ended before a specified date. When used in conjunction with the "endedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for lab instances who's last activity time is after a specified date. When used in conjunction with the "lastActivityTimeBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for lab instances who's last activity time is before a specified date. When used in conjunction with the "lastActivityTimeAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
OK Response
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
The total number of results that match the search conditions, not all of which may be in the current result set.
The total number of result pages that match the search conditions.
See LabInstanceSearchResult
The lab instance's unique identifier
The lab profile's unique identifier
The number/code of the lab
The name the lab
The user's unique identifier
The user's external ID, usually a unique identifier from the calling system
The user's first name
The user's last name
The unique identifier of the organization the user belongs to
When the lab instance started. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
When the lab instance ended. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
The text filter entered by the user
The amount of time expected for the lab to take in seconds
The percentage of the lab that has been completed by the user
Indicates the completion status of the lab instance. Possible Values:
- 0 = Cancelled
- 10 = In progress
- 20 = Complete
- 30 = Error
The unique identifier of the course the lab instance was launched from
The unique identifier of the course assignment the lab instance was launched from
The unique identifier of the class the lab instance was launched from
The unique identifier from the calling system for the class the lab instance was launched from
The user's ip address recorded when a new lab instance is launched
When student activity was last detected. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.