Skip to main content

Licenses

API docs by Redocly

SAM: Licenses (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with licenses.

Upgrades

Get license upgrades

Returns a collection of upgrades for a license.

Authorizations:
BearerAuth
path Parameters
id
required
string

The unique ID of the license.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license upgrade details

Returns the details of a license upgrade.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The license identifier.

upgradedLicenseId
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The upgrade license identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "licenseId": "string",
  • "quantity": 0,
  • "upgradedLicenseId": "string",
  • "upgradedQuantity": 0
}

Transfers

Get application license transfers

Returns a collection of computer license transfers for an application.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get application license transfers for a computer

Returns a collection of license transfers for specific application on a computer.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

computerId
required
string
Example: 7ebeed4a-e8c3-47c0-aec2-c22bec653b4a

The computer identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "_links": [
    ],
  • "id": "string",
  • "metricId": "string",
  • "fromApplicationId": "string",
  • "toApplicationId": "string",
  • "computerId": "string",
  • "licenseId": "string",
  • "organizationId": "string",
  • "isUpgrade": true,
  • "isDowngrade": true,
  • "isCrossEdition": true,
  • "isCrossPlatform": true,
  • "quantity": 0
}

Get custom value license transfers

Returns a collection of custom value license transfers.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license upgrade details

Returns a collection of license transfers for a given custom value.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

customId
required
string
Example: 7ebeed4a-e8c3-47c0-aec2-c22bec653b4a

The custom value identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get application license transfers

Returns a collection of license transfers for an application.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get users license transfer details

Returns a collection of user license transfers.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get user license transfer details

Returns a collection of license transfers for a given user.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

userId
required
string
Example: 351d6259-831e-4478-8ad4-8a11500c5731

The user identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Tracking

Get computer license tracking for a given application

Returns a collection of computer license tracking.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get application license tracking for a computer

Returns a collection of application license tracking for a given computer.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

computerId
required
string
Example: 7ebeed4a-e8c3-47c0-aec2-c22bec653b4a

The computer identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get application license tracking details

Returns a collection of license tracking for an application.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get users license tracking details

Returns a collection of users license tracking.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get application license tracking for a user

Returns a collection of license tracking for a given user.

Authorizations:
BearerAuth
path Parameters
applicationId
required
string
Example: 02f1bf0e-6340-4da3-9702-a06de2cd020b

The application identifier.

userId
required
string
Example: 351d6259-831e-4478-8ad4-8a11500c5731

The user identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Policies

Get license policy fields

Returns a collection of license policy fields.

Authorizations:
BearerAuth
path Parameters
policyId
required
string
Example: 38df6c48-b63f-4cb7-bb84-22ffb5dd23a9

The policy identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license policy field details

Returns the details of a license policy field.

Authorizations:
BearerAuth
path Parameters
policyId
required
string
Example: 38df6c48-b63f-4cb7-bb84-22ffb5dd23a9

The policy identifier.

fieldId
required
string
Example: 882ceb2d-1d5a-41e2-b25c-9cca9e694990

The field identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "isRequired": true,
  • "isComboBox": true,
  • "isEditingAllowed": true,
  • "listItems": [
    ]
}

Get license policies

Returns a collection of license policies.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license policy details

Returns the details of a license policy.

Authorizations:
BearerAuth
path Parameters
policyId
required
string
Example: 38df6c48-b63f-4cb7-bb84-22ffb5dd23a9

The policy identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string"
}

Licenses

Get licenses

Returns a collection of licenses.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license details

Returns the details of a license.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "547b6e50-6802-4ca0-86a9-e7051a92dc21",
  • "organizationId": "00000000-0000-0000-0000-000000000000",
  • "applicationId": "02f1bf0e-6340-4da3-9702-a06de2cd020b",
  • "metricId": "17a2241a-4f00-4827-bc02-ad14e578859e",
  • "purchaseDate": "5/25/2023 12:00:00 AM",
  • "purchaseValue": "100",
  • "purchaseCurrency": "USD",
  • "quantity": "1",
  • "licenseKeys": "15S45-7Y9L54-X8J7N",
  • "mediaStorage": "Not Applicable",
  • "licenseProofLocation": "Coupa",
  • "invoiceReference": "INV34907204",
  • "vendor": "CDW",
  • "notes": "Purchased for project Orion",
  • "externalId": "string",
  • "productDescription": "Fusion Software",
  • "isSubscription": "False",
  • "isCrossPlatform": "False",
  • "isUpgrade": "False",
  • "isDowngrade": "False",
  • "incompleteReasons": 0,
  • "contractId": "882ceb2d-1d5a-41e2-b25c-9cca9e694990"
}

Entitlements

Get license entitlements

Returns a collection of license entitlements.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get computers applications entitlements

Returns a collection of computers and applications entitlements.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license entitlement states

Returns a collection of entitlements states.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

Coverage

Get license extended coverage types

Returns a collection of extended coverage types.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get extended coverages

Returns a collection of extended coverages.

Authorizations:
BearerAuth
query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get extended coverage details

Returns the details of an extended coverage.

Authorizations:
BearerAuth
path Parameters
coverageId
required
string
Example: ac8469d5-a95a-419f-b03c-c36a87eafee6

The coverage identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "parentComputerId": "string",
  • "isParentComputerDatacenter": true,
  • "extendedComputerId": "string",
  • "applicationId": "string",
  • "coveredApplicationId": "string",
  • "reason": "Other",
  • "reasonDescription": "string"
}

Costs

Get license upgrade details

Returns a collection of license costs.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get a license costs for an organization

Returns the details of a license costs for an organization.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

organizationId
required
string
Example: 9aed6bd6-6a13-482f-a13a-45e6c1982a8b

The organization identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "licenseId": "string",
  • "organizationId": "string",
  • "licenseQuantity": 0,
  • "licensePurchaseCost": 0,
  • "currentMaintenanceCost": 0,
  • "accumulatedMaintenanceCost": 0,
  • "currentSupportCost": 0,
  • "accumulatedSupportCost": 0,
  • "totalCost": 0,
  • "currency": "string"
}

Get a license costs summary

Returns a summary of license costs.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "licenseId": "string",
  • "quantity": 0,
  • "purchaseCost": 0,
  • "currentMaintenanceCost": 0,
  • "accumulatedMaintenanceCost": 0,
  • "currentSupportCost": 0,
  • "accumulatedSupportCost": 0,
  • "totalCost": 0,
  • "averageCostPerLicensePurchase": 0,
  • "currency": "string"
}

Assignments

Get computer assignments for a license

Returns a collection of computer assignments for a license.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get assignment details for a computers license

Returns license details of a computer assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

assignmentId
required
string
Example: 53c15e5c-6311-430d-9e8e-a2680b3efcde

The assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "licenseId": "string",
  • "applicationId": "string",
  • "computerId": "string",
  • "quantity": 0
}

Get datacenter license assignments

Returns a collection of data center assignments.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get datacenter assignment details for a license

Returns the details of a data center assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

assignmentId
required
string
Example: 53c15e5c-6311-430d-9e8e-a2680b3efcde

The assignment identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "licenseId": "string",
  • "applicationId": "string",
  • "datacenterId": "string",
  • "quantity": 0
}

Get license assignments summary

Returns the details of a license assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "licenseId": "string",
  • "hasOrganizationAssignment": true,
  • "hasComputerAssignment": true,
  • "hasUserAssignment": true,
  • "hasSiteAssignment": true
}

Get organization assignments for a license

Returns a collection of organization assignments.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license details for an organization by assignment

Returns license details of an organization assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

assignmentId
required
string
Example: 53c15e5c-6311-430d-9e8e-a2680b3efcde

The assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "licenseId": "string",
  • "applicationId": "string",
  • "organizationId": "string",
  • "quantity": 0
}

Get site details for a license

Returns license details of a site assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "string",
  • "licenseId": "string",
  • "applicationId": "string",
  • "organizationId": "string",
  • "quantity": 0
}

Get license user assignments

Returns a collection of user assignments for a license.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

query Parameters
page_size
integer <= 1000
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string
Example: filter=status -eq "active"

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
{
  • "items": [
    ],
  • "pagination": {
    },
  • "_links": [
    ]
}

Get license details by users assignment

Returns license details of a user assignment.

Authorizations:
BearerAuth
path Parameters
id
required
string
Example: 547b6e50-6802-4ca0-86a9-e7051a92dc21

The license identifier.

assignmentId
required
string
Example: 53c15e5c-6311-430d-9e8e-a2680b3efcde

The assignment identifier.

Responses

Response samples

Content type
application/json
{
  • "_links": [
    ],
  • "id": "882ceb2d-1d5a-41e2-b25c-9cca9e694990",
  • "licenseId": "547b6e50-6802-4ca0-86a9-e7051a92dc21",
  • "applicationId": "02f1bf0e-6340-4da3-9702-a06de2cd020b",
  • "userId": "351d6259-831e-4478-8ad4-8a11500c5731",
  • "quantity": "1"
}