The Launch command will launch a specified lab for a specified user.
The ID of the lab profile.
The ID you use to identify the user in your external system.
The user’s first name.
The user’s last name.
The user’s email address.
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.
Enum: 1 2
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).
An optional parameter that can be used for tagging the lab instance with your own custom data.
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. IPv4 and IPv6 address are supported.
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.
Allows you specify the role(s) to assign to the user. You may pass multiple instances of this parameter to specify multiple roles. Roles are used for specialized integration purposes and are not needed in typical integration scenarios. Role IDs will be provided by Skillable when appropriate.
Allows you to set the values of named variables used within the lab instance. The key must start with the fixed text variable-.
The max number of labs an individual user may save is capped by the number configured on your API consumer.
The max number of concurrent lab instances is capped by the number configured on your API consumer.
Enum: "en" "es" "fr" "de" "pt" "ja" "zh" "ko"
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
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.
- "Result": 1,
- "LabInstanceId": 3896477,
- "Expires": 1337977153,
- "Status": 1,
- "Error": null