Oracle

• Categories
  • getGet a collection of product categories
  • getGet product category
• Compliance
  • getGet a collection of compliance status
  • getGet compliance status
  • getGet a collection of product compliance statuses
• Entitlements
  • getGet a collection of datacenter license compliance
  • getGet a collection of datacenter license assignments
  • getGet datacenter licence requirements
  • getGet a collection of server compliance statuses
  • getGet a collection of server license assignments
  • getGet a collection of server license requirements
  • getGet a collection of virtual machine license compliance
  • getGet a collection of virtual machine licence assignments
  • getGet a collection of virtual machine license requirements
  • getGet a collection of orders
  • getGet order
  • getGet license details of an order
  • getGet a collection of database compliance status
• Environment
  • getGet a collection of environment types
  • getGet environment type
• Installations
  • getGet a collection of Database installations
  • getGet details for a database installation
  • getGet collection of servers for an installation
  • getGet a collection of instances for an installation
  • getGet a collection of options for an installation
  • getGet a collection of management packs for an installation
  • getGet a collection of features for an installation
  • getGet a collection of users for an installation
  • getGet a collection of sessions for an installation
  • getGet a collection of options for an installation
  • getGet a collection of java installations
  • getGet details of a java installation
  • getGet a collection of featured for a java Installation
• License
  • getGet a collection of license item types
  • getGet license item type
  • getGet a collection of license metric types
  • getGet license metric type
  • getGet a collection of licensing types
  • getGet licensing type
• Middleware
  • getGet a collection of compliance status for any middleware product
  • getGet a collection of license assignments for any middleware product
  • getGet a collection of license requirements for any middleware product
  • getGet license compliance statuses for any middleware product
  • getGet a collection of license compiance for milldeware servers
  • getGet a collection of license requirements for milldeware servers
  • getGet a collection of compiance status for middleware virtual machines
  • getGet license assignments for middleware virtual machines
  • getGet license requirements for middleware virtual machines
  • getGet a collection of middleware installations
  • getGet middleware installation
  • getGet a collection of applications for a middleware installation
  • getGet a collection of middleware compliance status
• Partition
  • getGet a collection of partitioning types
  • getGet partitioning type
• Product
  • getGet product compliance status
  • getGet a collection of products
  • getGet product
  • getGet a collection of product types
  • getGet product type

API docs by Redocly

SAM: Oracle (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with Oracle.

Categories

Get a collection of product categories

Returns a collection of Oracle product categories.

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

https://{region}.snowsoftware.io/sam/oracle/v1/categories

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get product category

Returns the details of a given Oracle product category.

Authorizations:

BearerAuth

path Parameters

name required

string The partition type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/categories/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Compliance

Get a collection of compliance status

Returns a collection of Oracle compliance statuses.

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

https://{region}.snowsoftware.io/sam/oracle/v1/compliance-statuses

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get compliance status

Returns the details of a given Oracle compliance status.

Authorizations:

BearerAuth

path Parameters

name required

string The compliance status name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/compliance-statuses/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Get a collection of product compliance statuses

Returns a collection of Oracle product compliance statuses.

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

https://{region}.snowsoftware.io/sam/oracle/v1/product-compliance-statuses

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Entitlements

Get a collection of datacenter license compliance

Returns a collection of license compliance statuses with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/compliance/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of datacenter license assignments

Returns a collection of license assignments with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-assignments/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get datacenter licence requirements

Returns a collection of license requirements with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-requirements/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of server compliance statuses

Returns a collection of license compliance statuses with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/compliance/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of server license assignments

Returns a collection of license assignments with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-assignments/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of server license requirements

Returns a collection of license requirements with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-requirements/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of virtual machine license compliance

Returns a collection of license compliance statuses with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/compliance/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of virtual machine licence assignments

Returns a collection of license assignments with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-assignments/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of virtual machine license requirements

Returns a collection of license requirements with any Oracle Database product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/license-requirements/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of orders

Returns a collection of Oracle orders.

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

https://{region}.snowsoftware.io/sam/oracle/v1/entitlements/orders

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "orderDate": "2019-08-24T14:15:22Z",
    • "orderName": "string",
    • "oracleOrderNumber": "string",
    • "olsa": "string",
    • "areaOfUse": "string",
    • "createdDate": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get order

Returns the details of a given Oracle order.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the order.

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

https://{region}.snowsoftware.io/sam/oracle/v1/entitlements/orders/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "orderDate": "2019-08-24T14:15:22Z",
• "orderName": "string",
• "oracleOrderNumber": "string",
• "olsa": "string",
• "areaOfUse": "string",
• "createdDate": "2019-08-24T14:15:22Z"

}

Get license details of an order

Returns a collection of licenses for a uniquely identified Oracle order.

Authorizations:

BearerAuth

path Parameters

id required

string The order 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

https://{region}.snowsoftware.io/sam/oracle/v1/entitlements/orders/{id}/licenses

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "orderId": "string",
    • "itemType": "Default",
    • "referstoItemId": "string",
    • "productId": "string",
    • "licenseType": "string",
    • "licenseMetricType": "Nup",
    • "quantity": 0,
    • "licenseCost": 0,
    • "licenseCostBase": 0,
    • "supportCost": 0,
    • "supportCostBase": 0,
    • "csi": "string",
    • "supportContractId": 0,
    • "isPerpertual": true,
    • "nonPerpertualYears": 0

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of database compliance status

Returns a collection of Oracle Database product compliance statuses.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/entitlements/compliance/products

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "estateType": "VirtualMachines",
    • "estateName": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "isLicenseRequired": true,
    • "totalAssignedLicenseProcessor": 0,
    • "totalRequiredLicenseProcessor": 0,
    • "totalAssignedLicenseNup": 0,
    • "totalRequiredLicenseNup": 0,
    • "allInstallationsCount": 0,
    • "installationsRequiredLicenseCount": 0,
    • "installationsNotRequiredLicenseCount": 0,
    • "licenseMetricType": "Nup",
    • "productComplianceStatus": "Compliant",
    • "coveredByProductId": "string",
    • "coveredByEstate": "string",
    • "licenseNeeded": 0,
    • "partitioningType": "None"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Environment

Get a collection of environment types

Returns a collection of software environment 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/environment-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get environment type

Returns the details of a given software environment type.

Authorizations:

BearerAuth

path Parameters

name required

string The environment type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/environment-types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Installations

Get a collection of Database installations

Returns a collection of Oracle Database installations.

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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "databaseName": "string",
    • "productVersion": "string",
    • "isRac": true,
    • "isDataGuard": true,
    • "scanDate": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get details for a database installation

Returns the details of a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation identifier.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "identifier": "string",
    • "productVersion": "string",
    • "databaseName": "string",
    • "databaseUniqueName": "string",
    • "databaseDomain": "string",
    • "globalName": "string",
    • "mode": "string",
    • "scanDate": "2019-08-24T14:15:22Z",
    • "processorsAssigned": 0,
    • "cpuSocketCount": 0,
    • "cpuCoreCount": 0,
    • "cpuHighWater": 0,
    • "cpuCoreHighWater": 0,
    • "isManagedByOEM": true,
    • "isVaultInstalled": true,
    • "isVaultUsed": true,
    • "maxMemoryUsed": 0,
    • "isNoInventory": true,
    • "isUsedBy3PP": true,
    • "failOverClient": "string",
    • "failOverServer": "string",
    • "isDataGuard": true,
    • "logArchiveConfig": "string",
    • "databaseRole": "string",
    • "openMode": "string",
    • "switchoverStatus": "string",
    • "protectionMode": "string",
    • "isRac": true,
    • "isRMANDB": true,
    • "isOEMDB": true,
    • "isCDB": true,
    • "isPDB": true,
    • "numberOfInstances": 0,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "oracleDBID": "string",
    • "cdbDBID": "string",
    • "summary": {

      • "_links": [

        • {

          • "href": "sam/oracle/v1/...",
          • "rel": "self",
          • "method": "GET"

          }

        ],
      • "isOemReposPrior10G": true,
      • "isOemProgPrior10G": true,
      • "isOemRepos10GAndHigher": true,
      • "isOemPackGrant": true,
      • "isOemPackAgree": true,
      • "isOemManagedTargets": true,
      • "isDbControl10GPackGrant": true,
      • "isDbControl10GPackAgree": true,
      • "managementPackAccess11G": "string",
      • "isSqlProfilesUsed": true

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get collection of servers for an installation

Returns a collection of servers for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/servers

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "licensingCoreFactor": 0

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of instances for an installation

Returns a collection of instances for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/instances

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "instanceName": "string",
    • "hostName": "string",
    • "numberOfProcessorsAssigned": 0,
    • "cpuCoreCount": 0,
    • "cpuSocketCount": 0,
    • "cpuHighwater": 0,
    • "cpuCoreHighwater": 0,
    • "cpuSocketHighwater": 0,
    • "instanceId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of options for an installation

Returns a collection of options for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/options

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "tableOwner": "string",
    • "isInstalled": true,
    • "isUsed": true,
    • "lastUsed": "2019-08-24T14:15:22Z",
    • "firstUsed": "2019-08-24T14:15:22Z",
    • "detectedUsages": 0

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of management packs for an installation

Returns a collection of management packs for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/management-packs

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "isInstalled": true,
    • "isUsed": true,
    • "oraclePackUser": "string",
    • "oracleOemDate": "2019-08-24T14:15:22Z",
    • "isPackAccessGranted": true,
    • "isPackAccessAgreed": true,
    • "packAccessAgreedDate": "2019-08-24T14:15:22Z",
    • "packAccessAgreedBy": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of features for an installation

Returns a collection of features for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/features

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "name": "string",
    • "isUsed": true,
    • "firstUsed": "2019-08-24T14:15:22Z",
    • "lastUsed": "2019-08-24T14:15:22Z",
    • "description": "string",
    • "detectedUsages": 0

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of users for an installation

Returns a collection of users for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/users

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "userName": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "expireDate": "2019-08-24T14:15:22Z",
    • "accountStatus": "string",
    • "lockDate": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of sessions for an installation

Returns a collection of sessions for a uniquely identified Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/sessions

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "sessionId": "string",
    • "osUser": "string",
    • "clientProgram": "string",
    • "oracleUser": "string",
    • "logonTime": "2019-08-24T14:15:22Z",
    • "status": "string",
    • "isBackgroundSession": true,
    • "machine": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of options for an installation

Returns a collection of usage interpretations for a uniquely identified option and Oracle Database installation.

Authorizations:

BearerAuth

path Parameters

id required	string The installation identifier.
oid required	string The option 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

https://{region}.snowsoftware.io/sam/oracle/v1/database/installations/{id}/options/{oid}/usage

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "groupName": "string",
    • "isUsageTriggered": true,
    • "usageQueries": [

      • {

        • "_links": [

          • {

            • "href": "sam/oracle/v1/...",
            • "rel": "self",
            • "method": "GET"

            }

          ],
        • "queryName": "string",
        • "isUsageTriggered": true,
        • "usageFacts": [

          • {

            • "_links": [

              • {

                • "href": "sam/oracle/v1/...",
                • "rel": "self",
                • "method": "GET"

                }

              ],
            • "factName": "string",
            • "factValues": "string"

            }

          ]

        }

      ]

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of java installations

Returns a collection of Oracle Java installations.

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

https://{region}.snowsoftware.io/sam/oracle/v1/java/installations

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "productId": "string",
    • "runtimeName": "string",
    • "runtimeVersion": "string",
    • "vendor": "string",
    • "version": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get details of a java installation

Returns the details of a uniquely identified Oracle Java installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation identifier.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/java/installations/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "identifier": "string",
    • "productVersion": "string",
    • "databaseName": "string",
    • "databaseUniqueName": "string",
    • "databaseDomain": "string",
    • "globalName": "string",
    • "mode": "string",
    • "scanDate": "2019-08-24T14:15:22Z",
    • "processorsAssigned": 0,
    • "cpuSocketCount": 0,
    • "cpuCoreCount": 0,
    • "cpuHighWater": 0,
    • "cpuCoreHighWater": 0,
    • "isManagedByOEM": true,
    • "isVaultInstalled": true,
    • "isVaultUsed": true,
    • "maxMemoryUsed": 0,
    • "isNoInventory": true,
    • "isUsedBy3PP": true,
    • "failOverClient": "string",
    • "failOverServer": "string",
    • "isDataGuard": true,
    • "logArchiveConfig": "string",
    • "databaseRole": "string",
    • "openMode": "string",
    • "switchoverStatus": "string",
    • "protectionMode": "string",
    • "isRac": true,
    • "isRMANDB": true,
    • "isOEMDB": true,
    • "isCDB": true,
    • "isPDB": true,
    • "numberOfInstances": 0,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "oracleDBID": "string",
    • "cdbDBID": "string",
    • "summary": {

      • "_links": [

        • {

          • "href": "sam/oracle/v1/...",
          • "rel": "self",
          • "method": "GET"

          }

        ],
      • "isOemReposPrior10G": true,
      • "isOemProgPrior10G": true,
      • "isOemRepos10GAndHigher": true,
      • "isOemPackGrant": true,
      • "isOemPackAgree": true,
      • "isOemManagedTargets": true,
      • "isDbControl10GPackGrant": true,
      • "isDbControl10GPackAgree": true,
      • "managementPackAccess11G": "string",
      • "isSqlProfilesUsed": true

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of featured for a java Installation

Returns a collection of features for a uniquely identified Oracle Java installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/java/installations/{id}/features

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "computerId": "string",
    • "featureId": "string",
    • "name": "string",
    • "status": "string",
    • "version": "string",
    • "vendor": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "updatedDate": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

License

Get a collection of license item types

Returns a collection of Oracle license item 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/license-item-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license item type

Returns the details of a given Oracle license item type.

Authorizations:

BearerAuth

path Parameters

name required

string The license type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/license-item-types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Get a collection of license metric types

Returns a collection of Oracle license metric 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/license-metric-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license metric type

Returns the details of a given Oracle license metric type.

Authorizations:

BearerAuth

path Parameters

name required

string The license metric type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/license-metric-types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Get a collection of licensing types

Returns a collection of Oracle licensing 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/licensing-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get licensing type

Returns the details of a given Oracle licensing type.

Authorizations:

BearerAuth

path Parameters

name required

string The license type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/licensing-types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Middleware

Get a collection of compliance status for any middleware product

Returns a collection of license compliance statuses with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/compliance/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of license assignments for any middleware product

Returns a collection of license assignments with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-assignments/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of license requirements for any middleware product

Returns a collection of license requirements with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-requirements/datacenters

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license compliance statuses for any middleware product

Returns a collection of license compliance statuses with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/compliance/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of license compiance for milldeware servers

Returns a collection of license assignments with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-assignments/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of license requirements for milldeware servers

Returns a collection of license requirements with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-requirements/servers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of compiance status for middleware virtual machines

Returns a collection of license compliance statuses with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/compliance/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "estateType": "VirtualMachines",
    • "computerId": "string",
    • "datacenterId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license assignments for middleware virtual machines

Returns a collection of license assignments with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-assignments/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "orderId": "string",
    • "licenseId": "string",
    • "quantityAssigned": 0,
    • "isManualAssigned": true

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get license requirements for middleware virtual machines

Returns a collection of license requirements with any Oracle Middleware product.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/license-requirements/virtual-machines

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "estateType": "VirtualMachines",
    • "requiredQuantity": 0,
    • "requiredQuantityDecimal": 0,
    • "notAllowedLicensableEntityTypes": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of middleware installations

Returns a collection of Oracle Middleware installations.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/installations

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "computerId": "string",
    • "version": "string",
    • "oracleHomePath": "string",
    • "firstDiscovered": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get middleware installation

Returns the details of a given Oracle Middleware installation.

Authorizations:

BearerAuth

path Parameters

id required

string The unique ID of the installation.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/installations/{id}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productId": "string",
    • "identifier": "string",
    • "productVersion": "string",
    • "databaseName": "string",
    • "databaseUniqueName": "string",
    • "databaseDomain": "string",
    • "globalName": "string",
    • "mode": "string",
    • "scanDate": "2019-08-24T14:15:22Z",
    • "processorsAssigned": 0,
    • "cpuSocketCount": 0,
    • "cpuCoreCount": 0,
    • "cpuHighWater": 0,
    • "cpuCoreHighWater": 0,
    • "isManagedByOEM": true,
    • "isVaultInstalled": true,
    • "isVaultUsed": true,
    • "maxMemoryUsed": 0,
    • "isNoInventory": true,
    • "isUsedBy3PP": true,
    • "failOverClient": "string",
    • "failOverServer": "string",
    • "isDataGuard": true,
    • "logArchiveConfig": "string",
    • "databaseRole": "string",
    • "openMode": "string",
    • "switchoverStatus": "string",
    • "protectionMode": "string",
    • "isRac": true,
    • "isRMANDB": true,
    • "isOEMDB": true,
    • "isCDB": true,
    • "isPDB": true,
    • "numberOfInstances": 0,
    • "createdDate": "2019-08-24T14:15:22Z",
    • "oracleDBID": "string",
    • "cdbDBID": "string",
    • "summary": {

      • "_links": [

        • {

          • "href": "sam/oracle/v1/...",
          • "rel": "self",
          • "method": "GET"

          }

        ],
      • "isOemReposPrior10G": true,
      • "isOemProgPrior10G": true,
      • "isOemRepos10GAndHigher": true,
      • "isOemPackGrant": true,
      • "isOemPackAgree": true,
      • "isOemManagedTargets": true,
      • "isDbControl10GPackGrant": true,
      • "isDbControl10GPackAgree": true,
      • "managementPackAccess11G": "string",
      • "isSqlProfilesUsed": true

      }

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of applications for a middleware installation

Returns a collection of applications for a uniquely identified Oracle Middleware installation.

Authorizations:

BearerAuth

path Parameters

id required

string The installation 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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/installations/{id}/applications

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "version": "string",
    • "name": "string",
    • "applicationId": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get a collection of middleware compliance status

Returns a collection of Oracle Middleware product compliance statuses.

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

https://{region}.snowsoftware.io/sam/oracle/v1/middleware/entitlements/compliance/products

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "productId": "string",
    • "estateType": "VirtualMachines",
    • "estateName": "string",
    • "computerId": "string",
    • "datacenterId": "string",
    • "isLicenseRequired": true,
    • "totalAssignedLicenseProcessor": 0,
    • "totalRequiredLicenseProcessor": 0,
    • "totalAssignedLicenseNup": 0,
    • "totalRequiredLicenseNup": 0,
    • "allInstallationsCount": 0,
    • "installationsRequiredLicenseCount": 0,
    • "installationsNotRequiredLicenseCount": 0,
    • "licenseMetricType": "Nup",
    • "productComplianceStatus": "Compliant",
    • "coveredByProductId": "string",
    • "coveredByEstate": "string",
    • "licenseNeeded": 0,
    • "partitioningType": "None"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Partition

Get a collection of partitioning types

Returns a collection of Oracle partitioning 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/partitioning-types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get partitioning type

Returns the details of a given Oracle partitioning type.

Authorizations:

BearerAuth

path Parameters

name required

string The partition type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/partitioning-types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Product

Get product compliance status

Returns the details of a given Oracle product compliance status.

Authorizations:

BearerAuth

path Parameters

name required

string The status name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/product-compliance-statuses/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}

Get a collection of products

Returns a collection of Oracle products.

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

https://{region}.snowsoftware.io/sam/oracle/v1/products

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "id": "string",
    • "productName": "string",
    • "productEdition": "string",
    • "acronym": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get product

Returns the details of a given Oracle product.

Authorizations:

BearerAuth

path Parameters

id required

string The product identifier.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/products/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "id": "string",
• "productName": "string",
• "productEdition": "string",
• "acronym": "string"

}

Get a collection of product types

Returns a collection of Oracle product 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.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/types

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "items": [

  • {

    • "_links": [

      • {

        • "href": "sam/oracle/v1/...",
        • "rel": "self",
        • "method": "GET"

        }

      ],
    • "name": "string"

    }

  ],
• "pagination": {

  • "page_size": 100,
  • "page_number": 1,
  • "total_pages": 751

  },
• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ]

}

Get product type

Returns the details of a given Oracle product type.

Authorizations:

BearerAuth

path Parameters

name required

string The prodouct type name.

Responses

https://{region}.snowsoftware.io/sam/oracle/v1/types/{name}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "_links": [

  • {

    • "href": "sam/oracle/v1/...",
    • "rel": "self",
    • "method": "GET"

    }

  ],
• "name": "string"

}