Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide

PDF

GET method for Catalogs

This method returns the catalogs that are created in the appliance.

Description
Returns the list of catalogs.
Privilege
VIEW
HTTP response codes
200
Example request body 

{
  "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)",
  "@odata.count": 1,
  "value":
  [
    {
      "@odata.type": "#UpdateService.Catalogs",
      "@odata.id": "/api/UpdateService/Catalogs(22)",
      "Id": 22,
      "Filename": "catalog.xml",
      "SourcePath": "catalog/catalog.gz",
      "Status": "Completed",
      "TaskId": 27539,
      "BaseLocation": "ftp.dell.com",
      "ManifestIdentifier": "26920c45-0742-44cd-a2c6-c2f2d2df4037",
      "ReleaseIdentifier": "NH6TJ",
      "ManifestVersion": "18.07.02",
      "ReleaseDate": "2018-07-17 10:10:32.000",
      "LastUpdated": "2018-08-08 18:20:22.981",
      "BundlesCount": 230,
      "PredecessorIdentifier": "a05daa5b-7b98-413c-9000-5806cf1d836a",
      "AssociatedBaselines":
      [
        {
          "BaselineId": 10,
          "BaselineName": "No ID"
        },
        {
          "BaselineId": 9,
          "BaselineName": "Single"
        },
        {
          "BaselineId": 11,
          "BaselineName": "500"
        },
        {
          "BaselineId": 6,
          "BaselineName": "Test"
        },
        {
          "BaselineId": 7,
          "BaselineName": "Test 100"
        },
        {
          "BaselineId": 8,
          "BaselineName": "Test 2500+"
        }
      ],
      "Repository":
        {
          "@odata.type": "#UpdateService.Repository",
          "Id": 12,
          "Name": "Dell",
          "Description": "",
          "Source": "downloads.dell.com",
          "DomainName": null,
          "Username": null,
          "Password": null,
          "CheckCertificate": false,
          "RepositoryType": "DELL_ONLINE"
        }
    }
  ]
}
Example request body
Scheduled catalog download 
{
  "Id": 0,
  "Filename": "",
  "SourcePath": "",
  "Schedule": {
    "Cron": "0 0 5 ? * wed *",
    "StartTime": "2020-06-12T14:32:08.447Z"
  },
  "Repository": {
    "Id": 0,
    "Name": "test",
    "Description": "",
    "Source": "downloads.dell.com",
    "DomainName": "",
    "Username": "",
    "Password": "",
    "RepositoryType": "DELL_ONLINE"
  }
}
Table 1. AttributesThis table lists the attributes that this method supports.
Attribute Description
Filename File name of the catalog.
Schedule Specifies the start time when the catalog will be downloaded.
Cron Indicates whether the catalog must be downloaded daily, weekly, or at a specific time.
SourcePath Relative path of the catalog file from the repository (for example: downloads.dell.com/catalog/catalog.gz)
Status Status of creating the catalog.
TaskId The identifier of the task or job that is created to download the catalog.
BaseLocation The repository location for the catalog (for example for online catalogs, the location is downloads.dell.com)
ManifestIdentifier Catalog manifest identifier *.
ReleaseIdentifier Catalog release identifier *.
ManifestVersion Catalog manifest version *.
ReleaseDate Catalog release date *.
LastUpdated Date time when the catalog instance was updated in the appliance.
BundlesCount Number of bundles referenced in the catalog.
PredecessorIdentifier Identifier for the catalog version that was published before the current catalog.
AssociatedBaselines: The baselines that are associated with the catalog. This is an array.
BaselineId Identifier of a baseline associated with the catalog.
BaselineName Name of a baseline associated with the catalog.
Name Name of the repository.
Description User provided description for the repository.
Source URL or location of the repository.
DomainName Domain for the user credentials (CIFS only).
Username Username to access the share containing the catalog (CIFS / HTTPS).
Password Password to access the share containing the catalog (CIFS / HTTPS).
CheckCertificate Whether certificate checking is enabled for the HTTPS repository.
RepositoryType NFS / CIFS / HTTP / HTTPS/DELL_ONLINE

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\