Contents x
    Liquit.Catalog.Get
    • 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Liquit.Catalog.Get

    • Updated on 12 Dec 2023
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    The Liquit.Catalog.Get function returns all information on an application in the user catalog. Whenever an application has been made available in the Catalog it will be available in the response of this function.

    Request parameters

    The following parameters are available for the API:

    NameDescriptionValue
    idThe GUID needed to request the application<GUID>
    reviewsIf true, reviews will be included in the response (available for Liquit Workspace 3.6 and later)<boolean>
    mediaIf true, media will be included in the response (available for Liquit Workspace 3.6 and later)<boolean>
    faqIf true, the frequently asked questions will be included in the response (available for Liquit Workspace 3.6 and later)<boolean

    Return parameters

    The following properties are returned:

    NameDescriptionValue
    activeDetermines whether or not the application is active. If this is true, the application was already successfully requested.<boolean>
    categoriesReturns an array containing all categories associated with the application.<array[]>
    iconReturns the URL of the application icon.<string>
    idThe GUID of the application.<guid>
    nameThe friendly name of the application.<string>
    ratingThe global rating of the application.<int>
    statusThe status of the application:
    • active - The application has been requested and approved
    • available - The application can be requested and no approval workflow is configured, meaning it becomes available in the workspace immediately
    • pending - The application has been requested, however, an approval is still needed
    		<string>

    Example

    
				var id = '00000000-0000-0000-0000-000000000000';
				// Catalog get
				Liquit.Catalog.Get({
					id:id,
					media: true,
					license: true,
					reviews: true,
					faq: true
				}, function (fault, result) {
					console.log(result)
				});
    Was this article helpful?
    What's Next