Skip to main content

Applications

API docs by Redocly

SAM: Applications (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with applications.

Get registry applications

Returns a collection of registry applications.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get registry application

Returns the details of a registry application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "b814cda1-2c2a-455c-b288-57b642982eb0",
  • "name": "Oracle Database 21c",
  • "description": "Database by Oracle",
  • "metrics": [
    ],
  • "manufacturer": "UNETsystem",
  • "manufacturerWebsite": "www.ourcoolapp.com",
  • "language": "English",
  • "overridesApplicationId": "b0aef8cf-9338-4183-9569-96e81f5ea66e",
  • "isOs": true,
  • "isGroup": true,
  • "isBundle": true,
  • "isHidden": true,
  • "isNoLicenseRequired": true,
  • "isGloballyGeneratedApplication": true,
  • "familyId": "e5f53402-a698-40d3-b502-5b70b2dda5b2",
  • "editionIndex": 23,
  • "versionIndex": 4,
  • "isWebApplication": true,
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "endOfSupportDate": "2019-08-24T14:15:22Z",
  • "endOfLifeDate": "2019-08-24T14:15:22Z",
  • "endOfExtendedSupportDate": "2019-08-24T14:15:22Z",
  • "isEndOfLife": true,
  • "isEndOfSupport": true,
  • "isEndOfExtendedSupport": true,
  • "isReleaseDateNotAnnounced": true,
  • "isEndOfSupportDateNotAnnounced": true,
  • "isEndOfLifeDateNotAnnounced": true,
  • "isEndOfExtendedSupportDateNotAnnounced": true,
  • "platform": "Windows"
}

Get article numbers

Returns a collection of application article numbers.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get article number

Returns the details of a given application article number.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the application article number for which details will be returned.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "aedf5fac-b720-4a0f-a052-e38537a87cfb",
  • "applicationId": "5be51be2-35ff-48f2-9214-00002248b242",
  • "type": "Reseller",
  • "articleNumber": "Article Number 1"
}

Get compatible applications

Returns a collection of applications that are compatible with a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the compatible application.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get compatible application

Returns the details of a compatible application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

compatibilityId
required
string

The unique ID of the compatible application.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "applicationId": "b814cda1-2c2a-455c-b288-57b642982eb0",
  • "compatibleApplicationId": "ff8cbc59-bfc3-4733-adc3-7f4d80b88f91",
  • "compatibilityType": "Downgrade",
  • "compatibilityOrder": 2
}

Get families

Returns a collection of applications families.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string
Example: filter=

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get family

Returns the details of a given applications family.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the applications family.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "ba593a8f-1563-432a-8fe4-f0ae3cc60979",
  • "manufacturer": "Adobe",
  • "name": "Creative Cloud",
  • "description": "Includes Photoshop, Illustrator, Premiere Pro."
}

Get groups

Returns a collection of application groups for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get metrics

Returns a collection of application metrics for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get metric

Returns the details of an application metric.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

metricId
required
string

The unique ID of the application metric.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5891a1d8-7fb0-45bd-b1f6-01c943f9c572",
  • "name": "Metric name",
  • "isDefault": true,
  • "minimumRequirement": 56,
  • "metricSetting": "None",
  • "metricSettingIntervalType": "Continuous",
  • "metricSettingInterval": 4,
  • "customCompareValueType": "Custom compare value type",
  • "concurrencyInterval": 6,
  • "licenseCost": 299,
  • "licenseCostCurrency": "USD",
  • "licenseCostBase": 50.2
}

Get store

Returns the details of an application store for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "applicationId": "b4135599-2f9a-4ebc-ad8e-351575eacb70",
  • "name": "Joe's Computers",
  • "description": "307 Main Street",
  • "purchasePriceBase": 649.99,
  • "rentalPriceBase": 75,
  • "rentalPaymentPeriod": 6,
  • "imageName": "Store image",
  • "isOrganizationalApprovalRequired": true,
  • "isApplicationOwnerApprovalRequired": true,
  • "applicationOwnerUsername": "Ellie",
  • "isSecondApprovalRequired": true,
  • "secondApprovalUsername": "Bob",
  • "isThirdApprovalRequired": true,
  • "thirdApprovalUsername": "Parveen",
  • "provisioningGroupType": 72,
  • "provisioningGroupOU": "Name of organizational unit",
  • "computerGroupName": "Sales",
  • "userGroupName": "Technology",
  • "status": 3,
  • "publishLevel": 5,
  • "uninstallOption": 1,
  • "daysUntilUninstall": 103,
  • "daysUntilUninstallNotification": 96,
  • "subscriptionExtensionsDays": 101,
  • "isUserUninstallApprovalRequired": true
}

Get applications types

Returns a collection of application types.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get application types

Returns a collection of application types for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get application type

Returns the details of a given application type.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the application type.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "42767697-4849-4c42-bc79-6586e0c3722c",
  • "name": "Access software",
  • "parentId": "8dbec2e4-c131-4183-b2ee-9b05b53ec210",
  • "updatedDate": "2019-08-24T14:15:22Z"
}

Get bundles

Returns a collection of application bundles, or product suites, for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}

Get bundle

Returns the details of a given application bundle, or product suite, for a given application.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 5be51be2-35ff-48f2-9214-00002248b242

The unique ID of the application.

childId
required
string

The unique ID of the child application in the bundle or product suite for the application.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "5be51be2-35ff-48f2-9214-00002248b242",
  • "childId": "59e6cbf6-f8e1-4199-96a9-788f03dc2950",
  • "isMandatory": true,
  • "isOptionalComponentRequired": true
}

Get platforms

Returns a collection of application platforms.

Authorizations:
BearerAuth
query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "items": [
    ],
  • "_links": [
    ]
}