Launches a specified lab within an event using an external lab ID
The LaunchForEventByExternalId command launches a lab instance within an event by external ID.
Securityapi_key
Request
query Parameters
externalLabId
required
string
The external ID of the lab to launch. This should be the ID you use in your system.
Example: externalLabId=100
eventId
required
integer <int32>
The ID of the event the lab is part of.
Example: eventId=24
userid
required
string
The ID you use to identify the user in your external system.
Example: userid=555
firstname
required
string
The user’s first name.
Example: firstname=Joe
lastname
required
string
The user’s last name.
Example: lastname=Smith
email
required
string
The user’s email address.
Example: email=joe.smith@email.com
classId
string
An optional parameter used to associate the lab with a class (see GetOrCreateClass). This is the unique identifier of the class as it is represented in your organization.
Example: classId=1223334444
canBeMarkedComplete
integer <int32>
Default: 1
An optional parameter used to specify if the lab can be marked as complete by the student. 1 = true, 2 = false. If not specified, defaults to 1 (true).
Enum:12
Example: canBeMarkedComplete=1
tag
string
An optional parameter that can be used for tagging the lab instance with your own custom data.
Example: tag=eventLaunch
ipAddress
string
When specified, Skillable will attempt to launch the lab in the closest available delivery region. You should provide the IP address of the user that is taking the lab, not the IP address of your system.
Example: ipAddress=1.1.1.1
regionId
integer <int32>
When specified, Skillable will attempt to launch the lab in the specified delivery region if a suitable host in that region is available and all required storage is available in that region. Delivery regions can be found using the DeliveryRegions command or Catalog command. Using the ipAddress parameter will result in a more reliable geo-location of the lab for the end user.
Example: regionId=1
lang
string
Allows you to override the language of the Instruction Set as well as the lab client UI language. This affects lab client UI elements like menus, tabs, and dialogs. Using this in connection with instructionsId will allow you to select launching labs with a specific Instruction Set in the specified language if they have been defined within the lab profile.
NOTE: If this parameter is omitted, or if the specified language is not specified on one of the Instruction sets in a lab profile, then the default language as defined in the Lab Profile ➔ Manage Instructions Sets option.
en = English es = Spanish fr = French de = German pt = Portuguese ja = Japanese zh = Simplified Chinese ko = Korean
Enum:"en""es""fr""de""pt""ja""zh""ko"
Example: lang=en
instructionsId
string
When specified, Skillable will attempt to launch the lab and present the selected instructions. If not specified, or the instruction Id could not be found, the default instructions, as defined on the Lab Profile, will be used instead. This is a string that cannot contain spaces.
NOTE: To be able to see how to use this parameter, add the column "API Example" in the Manage Instruction Sets feature while editing the instructions.