Retrieves information about a specified lab profile
- 11 Oct 2024
- 5 Minutes to read
- Print
Retrieves information about a specified lab profile
- Updated on 11 Oct 2024
- 5 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/labprofile
The LabProfile command will return information about a specific lab profile.
Security
API Key
Header parameter nameapi_key
All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".
Query parameters
id
integer (int32) Required
The unique identifier of the lab profile.
Example77457
Responses
200
OK Response.
Example of returning information a specific lab profile
{
"Error": null,
"Status": 1,
"Id": 1,
"Name": "Demo Lab 1",
"Number": " Module 1",
"PlatformId": 2,
"Platform": 2,
"CloudPlatformId": null,
"SeriesId": 1,
"OrganizationId": 5,
"Enabled": true,
"ReasonDisabled": null,
"DevelopmentStatusId": 10,
"DevelopmentStatus": 10,
"RequiresBrowserPlugin": false,
"RequiresNestedVirtualization": false,
"NumPublicIpAddresses": 0,
"Description": "A demo lab.",
"Objective": "This is the HTML-formatted objective of the lab",
"Scenario": " This is the HTML-formatted scenario of the lab",
"DurationMinutes": 360,
"ExpectedDurationMinutes": 360,
"ResourceUnits": 16,
"Ram": 512,
"HasIntegratedContent": true,
"ContentVersion": 2,
"IsExam": false,
"PremiumPrice": 10,
"BasicPrice": 8,
"PricePerHour": 2,
"ExpectedCloudCost": 0,
"ParticipantLabPrice": 0,
"ExamPages": [
"Empty"
],
"SharedClassEnvironmentRoleId": 0,
"SharedClassEnvironmentRole": 0,
"SharedClassEnvironmentLabProfileId": 0,
"UsesRdp": false,
"Tags": [
"Tag1",
"Tag2"
],
"InstructionSets": [
{
"Id": "Base-01",
"Language": "en",
"Description": "Basic Instructions",
"LabTitle": "A demo lab",
"DurationMinutes": 360,
"OrganizationId": 1
},
{
"Id": "Base-01",
"Language": "fr",
"Description": "Instructions de base",
"LabTitle": "Un laboratoire de démonstration",
"DurationMinutes": 360,
"OrganizationId": 1
}
],
"Created": 1656366326607,
"LastModified": 1656440153550,
"SCORMLastDownloaded": 1755781199000
}object
Error
string | null
In the event of an error, this will contain a detailed error message.
Status
integer (int32)
Indicates the status of the API request.
0 = Error
1 = Success
Id
integer (int32)
The unique identifier of the lab profile.
Name
string
The name of the lab profile.
Number
string | null
The lab number (usually to identify a lab within a series, e.g. Module 1, Module 2, etc.).
PlatformId
integer (int32)
The virtualization platform the lab is run on.
1 = None
2 = Hyper-V
3 = ESX
10 = Azure
11 = AWS
20 = Docker
Platform
integer (int32) Deprecated
This response property is obsolete, and will show the same value as PlatformId.
CloudPlatformId
integer (int32) | null
The cloud platform the lab is run on.
null = None
10 = Azure
11 = AWS
SeriesId
integer (int32) | null
The unique identifier of the series the lab profile belongs to.
OrganizationId
integer (int32) | null
The unique identifier of the Organization the lab profile belongs to.
Enabled
boolean
Whether the lab is currently enabled for launch.
ReasonDisabled
string | null
The reason the lab is disabled. Only supplied when the lab is not enabled.
DevelopmentStatusId
integer (int32)
Indicates the development status of the lab. In general, a lab not marked as Complete should not be launched (though it can be).
1 = In Development
5 = AwaitingVerification
7 = InVerification
8 = VerificationFailed
10 = Complete
DevelopmentStatus
integer (int32) Deprecated
This response property is obsolete, and will show the same values as DevelopmentStatusId.
RequiresBrowserPlugin
boolean
Indicates if this lab profile requires the use of a browser plugin.
RequiresNestedVirtualization
boolean
Indicates if this lab profile requires the use of nested virtualization.
NumPublicIpAddresses
integer (int32)
Indicates the number of public ip addresses used in this lab profile.
Description
string | null
A brief description of the lab profile.
Objective
string | null
Text describing the objective of the lab.
Scenario
string | null
Text describing the scenario of the lab.
DurationMinutes
integer (int32)
The maximum number of minutes a lab instance is allowed to run before it expires.
ExpectedDurationMinutes
integer (int32) Deprecated
This response property is obsolete, and will reflect the same value shown for DurationMinutes.
ResourceUnits
integer (int32) Deprecated
This response property is obsolete, and will show the value of RAM/32.
Ram
integer (int32)
The amount of RAM in MB used by the lab.
HasIntegratedContent
boolean
Indicates whether the lab has integrated digital lab (IDL) content.
ContentVersion
integer (int32)
Indicates the content version (only applicable if HasIntegratedContent = true).
IsExam
boolean
Indicates whether the lab is scored.
PremiumPrice
number (float)
The consumption cost of the lab when premium experience features are included.
BasicPrice
number (float)
The consumption cost of the lab when only basic experience features are included.
PricePerHour
number (float)
The hourly consumption cost of the lab when only basic experience features are included.
ExpectedCloudCost
number (float) | null
The expected cloud cost of the lab.
ParticipantLabPrice
number (float) | null
The expected participant cost of the shared lab.
SharedClassEnvironmentRoleId
integer (int32) | null
Indicates the role the lab plays in a shared environment.
0 = None. This lab has no shared environment involvement at all. Most labs work this way.)
10 = Shared Environment. This lab provides the shared infrastructure that participant labs will connect into. Typically launched and maintained by an administrator or instructor.
20 = Participant. This lab will connect into shared environments and act as a participant. Typically launched by students.
SharedClassEnvironmentRole
integer (int32) | null Deprecated
This response property is obsolete, and will show the same value as SharedClassEnvironmentRoleId.
SharedClassEnvironmentLabProfileId
integer (int32) | null
The id of the lab profile that will be used in the shared class environment.
UsesRdp
boolean
Indicates whether this lab profile uses Remote Desktop Protocol (RDP) or not.
ExamPages
Array of string Deprecated
This response property is obsolete and is not Populated.
string
Tags
Array of string
A list of tags associated with the lab profile.
string
InstructionSets
Array of object
A list of the available instruction sets and their basic details for the lab profile.
object
Id
string
The unique identifier of the instruction set.
Language
string
The character code for the language of the instruction set.
en = English
es = Spanish
fr = French
de = German
pt = Portuguese
ja = Japanese
zh-hans = Simplified Chinese
zh-hant = Traditional Chinese
ko = Korean
Description
string
The description of the instruction set.
LabTitle
string
The title of the lab as used in this instruction set.
DurationMinutes
integer
The duration of the lab, in minutes, when using this instruction set.
OrganizationId
integer
The unique identifier of the organization to which this instruction set belongs.
Created
integer (int64)
The date when the lab profile was created (in Unix epoch time).
LastModified
integer (int64)
The date when the lab profile was last modified (in Unix epoch time).
SCORMLastDownloaded
integer (int64)
The date when the SCORM package was last downloaded for the lab profile (in Unix epoch time).
Skills
Array of object
A list of the skills assigned to the lab profile and their basic details.
object
Id
integer
The unique identifier of the skill.
ExternalId
string | null
The optional external unique identifier of the skill.
Name
string
The name of the skill.
FrameworkId
integer
The unique identifier of the framework for this skill.
FrameworkName
string
The name of the framework for this skill.
Was this article helpful?