Search for lab instances
- 16 Jul 2024
- 5 Minutes to read
- Print
Search for lab instances
- Updated on 16 Jul 2024
- 5 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchLabInstances
Allows you to search for lab instances.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
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).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
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
userId
integer (int32)
An optional parameter used to filter for lab instances run by a particular user
userExternalId
integer (int32)
An optional parameter used to filter for lab instances for a particular user using an external identifier
labId
integer (int32)
An optional parameter used to filter for instances of a particular lab
courseId
integer (int32)
An optional parameter used to filter for lab instances launched from a particular course
classId
integer (int32)
An optional parameter used to filter for lab instances launched from a particular class
classExternalId
string
An optional parameter used to filter for lab instances launched from a particular class. Usually a unique identifier from the calling system.
completionStatus
integer (int32)
Filters for lab instances with a particular completion status. Possible values:
- 0 = Cancelled
- 10 = In progress
- 20 = Complete
- 30 = Error
startedAfter
integer (int64)
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.
startedBefore
integer (int64)
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.
endedAfter
integer (int64)
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.
endedBefore
integer (int64)
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.
lastActivityTimeAfter
integer (int64)
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.
lastActivityTimeBefore
integer (int64)
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.
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Results
Array of object (LabInstanceSearchResult)
See LabInstanceSearchResult
object
Id
integer (int64)
The lab instance's unique identifier
Example4042909
LabId
integer (int32)
The lab profile's unique identifier
Example6742
LabNumber
string
The number/code of the lab
ExampleLab201
LabName
string
The name the lab
ExampleSample lab name
UserId
integer (int32)
The user's unique identifier
Example78956
UserExternalId
string | null
The user's external ID, usually a unique identifier from the calling system
Example89CFAB18-443D-495C-89B0-95A85E0A00BA
FirstName
string
The user's first name
ExampleJane
LastName
string
The user's last name
ExampleDoe
OrganizationId
integer (int32)
The unique identifier of the organization the user belongs to
Example457
Start
integer (int64)
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.
Example1465500264
End
integer (int64) | null
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.
Example1465500264
TotalRunTimeSeconds
integer (int32) | null
The text filter entered by the user
Example164
ExpectedDurationSeconds
integer (int32) | null
The amount of time expected for the lab to take in seconds
Example43200
TaskCompletePercent
integer (int32)
The percentage of the lab that has been completed by the user
Example0
CompletionStatus
integer (int32) | null
Indicates the completion status of the lab instance. Possible Values:
- 0 = Cancelled
- 10 = In progress
- 20 = Complete
- 30 = Error
Example10
CourseId
integer (int32) | null
The unique identifier of the course the lab instance was launched from
Example33410
CourseAssignmentId
integer (int32) | null
The unique identifier of the course assignment the lab instance was launched from
Example315143
ClassId
integer (int32) | null
The unique identifier of the class the lab instance was launched from
Example56476
ClassExternalId
string | null
The unique identifier from the calling system for the class the lab instance was launched from
ExampleABC123
UserIpAddress
string | null
The user's ip address recorded when a new lab instance is launched
Example127.0.0.1
LastActivityTime
integer (int64) | null
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.
Example1585690845
Was this article helpful?