Table of Contents

Looking up an item in the Catalog

Looking up an item using the Catalog UI

When you open up the Catalog, a search box is displayed.

  1. In the search box, you can enter:

    • (Part of) the name of the item you are looking for (e.g. a connector, a package, etc.).

    • (Part of) a tag given to the item you are looking for (e.g. Master Clock System, Element Manager, etc.).

    As you type, a list with the top 5 results will be displayed under the search box.

  2. If you cannot find the item you are looking for in the list, click View all results at the bottom of the list to open the browse page.

    This page contains all search results, and has filters on the left that allow you to narrow down your search.

    If you only want to see the items that have been registered by your organization, you can use the All/Public/Private filter:

    • All: This will return search results from all items in the Catalog that you have access to. This includes the private items that are only visible to people in your organization.
    • Public: This will only return results that are publicly available to everyone.
    • Private: This will only return results from the private items that are only visible to people in your organization.

  3. If you see the item you are looking for, click it to open a page where you can see information about that item and its versions.

    From here, you can also deploy the item to your DataMiner System.

    Tip

    See also: Versioning of Catalog items

Looking up an item using the Catalog API

The Catalog API allows you to retrieve information of a Catalog item.

Note

The API calls are authenticated using organization keys. Make sure you use a key that has the Read Catalog items permission and add it to the HTTP request in a header called Ocp-Apim-Subscription-Key. The API calls use the following rate limiting policy:

  • Partition key: IP address or hostname of connection
  • Burst limit: 100 requests
  • Long-term sustained request rate: 1 request every 36 seconds (100 request per hour)
  • No queueing for extra requests beyond the token bucket

API definition

For a complete definition of the API, go to Key Catalog API Swagger.

This page also provides a quick way to execute the call: Expand the "/api/key-catalog/v2-0/catalogs/{catalogId}" item, and click the Try it out button.

Important

Clicking the Try it out button will execute the call on the production Catalog.

The Swagger.json can be used by e.g. Swagger CodeGen or AutoRest to generate client code.

HTTP method

GET

Route parameters

Route parameter "catalogId" is the ID of the Catalog item for which information will be retrieved, which is the same as the ID used to register the Catalog item. This must be a valid GUID.

To obtain this ID for an existing Catalog item, navigate to its details page in the Catalog. The ID is the last part of the URL.

Looking up a version of an item with the Catalog API

The versions API call allows you to retrieve version information for a Catalog item.

Note

The API calls are authenticated using organization keys. Make sure you use a key that has the Read Catalog items permission and add it to the HTTP request in a header called Ocp-Apim-Subscription-Key. The API calls use the following rate limiting policy:

  • Partition key: IP address or hostname of connection
  • Burst limit: 100 requests
  • Long-term sustained request rate: 1 request every 36 seconds (100 request per hour)
  • No queueing for extra requests beyond the token bucket

API Definition

For a complete definition of the API, go to Key Catalog API Swagger.

This page also provides a quick way to execute the call: Expand the "/api/key-catalog/v2-0/catalogs/{catalogId}/versions" item, and click the Try it out button.

Important

Clicking the Try it out button will execute the call on the production Catalog.

The Swagger.json can be used by e.g. Swagger CodeGen or AutoRest to generate client code.

HTTP method

GET

Route parameters

Route parameter "catalogId" is the ID of the Catalog item for which version information will be retrieved, which is the same as the ID used to register the Catalog item. This must be a valid GUID.

To obtain this ID for an existing Catalog item, navigate to its details page in the Catalog. The ID is the last part of the URL.

Improve this page