CatalogData

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

The requests are sent to the hostname determined in the hostname document, Hostname API.

For example, if the App Registration hostname is nvuprd-sfc.ivanticloud.com and you are requesting packages from CatalogData, send a GET request to https://nvuprd-sfc.ivanticloud.com/api/SwdPackage/catalog/external?api-version=1.0.

The api-version can usually be omitted. If it is used, the version is usually 1.0, for example:
https://nvuprd-sfc.ivanticloud.com/api/SwdPackage/catalog/external?api-version=1.0

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 /api/SwdPackage/catalog/external

Returns the packageId of the newly created item.

Example Request


                POST api/SwdPackage/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}

             }
  
 

PATCH Method

Request URI

PATCH api/SwdPackage/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 Authentication 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 api/SwdPackage/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 Authentication 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 api/SwdPackage/catalog/external

This request gets all the catalogs.

Header Parameters

Name Type Description

Authorization

String

Use the Bearer <access-token> value determined during the Authentication 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"
}