OpenManage Enterprise 3.10 RESTful API Guide

GET method for Catalogs

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

Description

Returns the list of catalogs.

NOTE:Driver updates are applicable only to OpenManage Enterprise.

Privilege

VIEW

HTTP response codes

200

Example request body

{
    "@odata.context": "/api/$metadata#Collection(UpdateService.Catalogs)",
    "@odata.count": 4,
    "value": [
        {
            "@odata.type": "#UpdateService.Catalogs",
            "@odata.id": "/api/UpdateService/Catalogs(22)",
            "Id": 22,
            "Filename": "Catalog.xml",
            "SourcePath": "share/Catalog/14000",
            "Status": "Completed",
            "TaskId": 11982,
            "BaseLocation": "downloads.dell.com",
            "ManifestIdentifier": "90d43ab2-c5f0-4219-b9a0-96a934849436",
            "ReleaseIdentifier": "6H6H9",
            "ManifestVersion": "3.97",
            "CreatedDate": "2021-10-26 14:04:02.0",
            "LastUpdated": "2021-10-27 04:30:00.502",
            "NextUpdate": "2021-10-28 04:30:00.0",
            "Schedule": {
                "StartTime": null,
                "EndTime": null,
                "Cron": "0 30 4 * * ? *"
            },
            "BundlesCount": 4,
            "PredecessorIdentifier": "",
            "AssociatedBaselines": [
                {
                    "BaselineId": 7,
                    "BaselineName": "NFS"
                }
            ],
            "Repository": {
                "@odata.type": "#UpdateService.Repository",
                "Id": 12,
                "Name": "NFS",
                "Description": "",
                "Source": "100.97.210.96",
                "DomainName": null,
                "Username": null,
                "Password": null,
                "CheckCertificate": false,
                "RepositoryType": "NFS",
                "BackupExistingCatalog": false,
                "Editable": true
            }
        },
        {
            "@odata.type": "#UpdateService.Catalogs",
            "@odata.id": "/api/UpdateService/Catalogs(23)",
            "Id": 23,
            "Filename": "Catalog.xml",
            "SourcePath": "share/Catalog/14000",
            "Status": "Completed",
            "TaskId": 11983,
            "BaseLocation": "downloads.dell.com",
            "ManifestIdentifier": "90d43ab2-c5f0-4219-b9a0-96a934849436",
            "ReleaseIdentifier": "6H6H9",
            "ManifestVersion": "3.97",
            "CreatedDate": "2021-10-26 14:04:02.0",
            "LastUpdated": "2021-10-27 04:30:00.517",
            "NextUpdate": "2021-10-28 04:30:00.0",
            "Schedule": {
                "StartTime": null,
                "EndTime": null,
                "Cron": "0 30 4 * * ? *"
            },
            "BundlesCount": 4,
            "PredecessorIdentifier": "",
            "AssociatedBaselines": [
                {
                    "BaselineId": 6,
                    "BaselineName": "CIFS"
                }
            ],
            "Repository": {
                "@odata.type": "#UpdateService.Repository",
                "Id": 13,
                "Name": "CIFS",
                "Description": "",
                "Source": "100.97.210.96",
                "DomainName": "",
                "Username": "administrator",
                "Password": null,
                "CheckCertificate": false,
                "RepositoryType": "CIFS",
                "BackupExistingCatalog": false,
                "Editable": true
            }
        },
        {
            "@odata.type": "#UpdateService.Catalogs",
            "@odata.id": "/api/UpdateService/Catalogs(24)",
            "Id": 24,
            "Filename": "Catalog.xml",
            "SourcePath": "Catalog/14000",
            "Status": "Completed",
            "TaskId": 11984,
            "BaseLocation": "downloads.dell.com",
            "ManifestIdentifier": "90d43ab2-c5f0-4219-b9a0-96a934849436",
            "ReleaseIdentifier": "6H6H9",
            "ManifestVersion": "3.97",
            "CreatedDate": "2021-10-26 14:04:02.0",
            "LastUpdated": "2021-10-27 04:30:00.387",
            "NextUpdate": "2021-10-28 04:30:00.0",
            "Schedule": {
                "StartTime": null,
                "EndTime": null,
                "Cron": "0 30 4 * * ? *"
            },
            "BundlesCount": 4,
            "PredecessorIdentifier": "",
            "AssociatedBaselines": [
                {
                    "BaselineId": 8,
                    "BaselineName": "HTTP"
                }
            ],
            "Repository": {
                "@odata.type": "#UpdateService.Repository",
                "Id": 14,
                "Name": "HTTP",
                "Description": "",
                "Source": "100.97.210.96",
                "DomainName": null,
                "Username": null,
                "Password": null,
                "CheckCertificate": false,
                "RepositoryType": "HTTP",
                "BackupExistingCatalog": false,
                "Editable": true
            }
        },
        {
            "@odata.type": "#UpdateService.Catalogs",
            "@odata.id": "/api/UpdateService/Catalogs(25)",
            "Id": 25,
            "Filename": "Catalog.xml",
            "SourcePath": "Catalog/14000",
            "Status": "Completed",
            "TaskId": 11985,
            "BaseLocation": "downloads.dell.com",
            "ManifestIdentifier": "90d43ab2-c5f0-4219-b9a0-96a934849436",
            "ReleaseIdentifier": "6H6H9",
            "ManifestVersion": "3.97",
            "CreatedDate": "2021-10-26 14:04:02.0",
            "LastUpdated": "2021-10-27 04:30:00.319",
            "NextUpdate": "2021-10-28 04:30:00.0",
            "Schedule": {
                "StartTime": null,
                "EndTime": null,
                "Cron": "0 30 4 * * ? *"
            },
            "BundlesCount": 4,
            "PredecessorIdentifier": "",
            "AssociatedBaselines": [
                {
                    "BaselineId": 9,
                    "BaselineName": "HTTPS"
                }
            ],
            "Repository": {
                "@odata.type": "#UpdateService.Repository",
                "Id": 15,
                "Name": "HTTPS",
                "Description": "",
                "Source": "100.97.210.96",
                "DomainName": "",
                "Username": "",
                "Password": null,
                "CheckCertificate": true,
                "RepositoryType": "HTTPS",
                "BackupExistingCatalog": false,
                "Editable": true
            }
        }
    ]
}

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 time when the catalog download begins.
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 *.
CreatedDate	Catalog created 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

Table 2. FiltersThis table lists the filters that can be applied to the response values.
Filter	Description
Top	Top records to return.
Skip	Max records to skip.
OwnerID	Filter by owner identified by ID.

OpenManage Enterprise 3.10 RESTful API Guide

GET method for Catalogs

Rate this content