CatalogData

The following lists the HTTP methods, you to access the data from the catalog.

HTTP Method - POST

Returns an action and creates a new resource (ID set by service).

HTTP Method - PATCH

Edits the catalog record.

HTTP Method - DELETE

Deletes the catalog record for the specified packageId, along with all associated Package revisions, Distributions, and Deployment Status records related to this app.

HTTP Method - GET

Returns a resource and resource collection.

Returns the package revisions in the application's user interface.

POST Method

Request URI

POST /catalog/external

Returns the packageId of the newly created item.

Request Body Parameters

Name Type Description
api-version

String

The current API version number.

Example Request


                POST /catalog/external

                {

                 "packageName": "App #1",

                "platform": "Windows",

                "showInAnalystView": true,

                "notes": "This is a test app",

                "version": "1.0.0",

                "publisher": "Publisher"

                "size": "123 MB"

                "icon": "{base64 encoded image}"

                "iconPrefix": "data:image/svg-xml;base64,"

                "category": "{a category defined in the category Settings}

             }
  
 

Example Response


                {
                "errors": null,
                "result": 200
                }

PATCH Method

Request URI

PATCH /catalog/external/{packageId}

This request edits all the catalogs.

Header Parameters

Name Type Description

Authorization

String

Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.

packageId

String

Gets the package details for the particular package ID.

Request Body Parameters

Name Type Description
api-version

String

The current API version number.

Example Response

{
  "packageId": "string",
  "packageName": "string",
  "packageNameForSorting": "string",
  "platform": "Windows",
  "created": "2024-08-12T07:33:28.890Z",
  "createdById": "string",
  "createdByName": "string",
  "lastModified": "2024-08-12T07:33:28.890Z",
  "lastModifiedById": "string",
  "lastModifiedByName": "string",
  "notes": "string",
  "showInAnalystView": false,
  "packageExists": true,
  "compliantCount": 0,
  "notCompliantCount": 0,
  "notApplicableCount": 0,
  "unknownCount": 0,
  "tags": [
    "string"
  ],
  "version": "string",
  "publisher": "string"
}

DELETE Method

Request URI

DELETE /catalog/external/{packageId}

This request deletes the catalog records.

Header Parameters

Name Type Description

Authorization

String

Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.

packageId

String

Gets the package details for the particular package ID.

Request Body Parameters

Name Type Description
api-version

String

The current API version number.

Example Response

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

GET Method

Request URI

GET /catalog/external/{packageId}

This request gets all the catalogs.

Header Parameters

Name Type Description

Authorization

String

Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.

packageId

String

Gets the package details for the particular package ID.

Request Body Parameters

Name Type Description
api-version

String

The current API version number.

Example Response

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}