catalogadminitems#

async idem_vra.exec.vra.catalog.catalogadminitems.get_catalog_item_using_get4(hub, ctx, p_id, **kwargs)[source]#

Find a catalog item with specified id. Returns the catalog item with the specified id. Performs GET /catalog/api/admin/items/{id}

Parameters:
  • p_id (string) – (required in path) Catalog item id

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • includeSource (boolean) – (optional in query) Includes the Content Source metadata for the Catalog Item

async idem_vra.exec.vra.catalog.catalogadminitems.get_catalog_items_using_get4(hub, ctx, **kwargs)[source]#

Fetch a list of catalog items. Returns a paginated list of catalog items. Performs GET /catalog/api/admin/items

Parameters:
  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • projectId (string) – (optional in query) Matches which can be requested within project with the given projectId

  • search (string) – (optional in query) Matches will have this string somewhere in their name or description.

  • sourceIds (array) – (optional in query) A list of Content Source IDs. Results will be from one of these sources.

  • types (array) – (optional in query) A list of Catalog Item Type IDs. Results will be one of these types.

async idem_vra.exec.vra.catalog.catalogadminitems.update_catalog_item_using_patch2(hub, ctx, p_id, **kwargs)[source]#

Set an icon or request limit to a catalog item. Updates a catalog item with specified icon id or request limit. Performs PATCH /catalog/api/admin/items/{id}

Parameters:
  • p_id (string) – (required in path) The unique id of item to update.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • bulkRequestLimit (integer) – (optional in body) Max number of instances that can be requested at a time

  • formId (string) – (optional in body) form id

  • iconId (string) – (optional in body) icon id