Returns the contents of the instructions for a specific lab as a file archive
    • 11 Oct 2024
    • 1 Minute to read

    Returns the contents of the instructions for a specific lab as a file archive


    Article summary

    Get
    /GetLabInstructionsPackage

    The GetLabInstructionsPackage command allows you to download the IDLx instructions of a lab as an archived file.

    The results are returned as a compressed format that can be exported as a .zip file when using Postman. There is an additional Header parameter Content-Disposition that is returned which contains the name of the lab.

    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 ID of the lab profile that will be the source of the instructions. The profile must be owned by the organization on the API consumer.

    Example2393048
    lang
    string

    Allows you to select the language of the Instruction Set. Using this in connection with instructionsId will allow you to select a specific lab 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 will be used instead.

    en = English
    es = Spanish
    fr = French
    de = German
    pt = Portuguese
    ja = Japanese
    zh-hans = Simplified Chinese
    zh-hant = Traditional Chinese
    ko = Korean

    Valid values[ "en", "es", "fr", "de", "pt", "ja", "zh-hans", "zh-hant", "ko" ]
    Exampleen
    instructionsId
    string

    When specified, Skillable will attempt to retrieve 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.

    ExampleBase-01
    Responses
    200

    OK Response.

    Headers
    Content-Disposition
    string
    attachment; filename="DemoLab.zip" **Note:** The filename will contain the name of the Lab Profile.
    object
    string (binary)

    The raw binary compressed package.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.