{ "openapi": "3.0.0", "info": { "title": "SAM: Oracle", "description": "API for interacting with Oracle.", "version": "1.1.0", "contact": { "name": "Flexera", "url": "https://www.flexera.com" } }, "servers": [ { "url": "https://{region}.snowsoftware.io", "variables": { "region": { "enum": [ "westeurope", "australiasoutheast", "eastus2", "uksouth" ], "default": "westeurope" } } } ], "tags": [ { "name": "Categories" }, { "name": "Compliance" }, { "name": "Entitlements" }, { "name": "Environment" }, { "name": "Installations" }, { "name": "License" }, { "name": "Middleware" }, { "name": "Partition" }, { "name": "Product" } ], "paths": { "/api/sam/v1/oracle/database/entitlements/compliance/datacenters": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Database product.", "operationId": "getDatacenters", "summary": "Get a collection of datacenter license compliance", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-assignments/datacenters": { "get": { "description": "Returns a collection of license assignments with any Oracle Database product.", "operationId": "getDatacenters2", "summary": "Get a collection of datacenter license assignments", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-requirements/datacenters": { "get": { "description": "Returns a collection of license requirements with any Oracle Database product.", "operationId": "getDatacenters3", "summary": "Get datacenter license requirements", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/compliance/servers": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Database product.", "operationId": "getServers", "summary": "Get a collection of server compliance statuses", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-assignments/servers": { "get": { "description": "Returns a collection of license assignments with any Oracle Database product.", "operationId": "getServers2", "summary": "Get a collection of server license assignments", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-requirements/servers": { "get": { "description": "Returns a collection of license requirements with any Oracle Database product.", "operationId": "getServers3", "summary": "Get a collection of server license requirements", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/compliance/virtual-machines": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Database product.", "operationId": "getVirtualMachines", "summary": "Get a collection of virtual machine license compliance", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-assignments/virtual-machines": { "get": { "description": "Returns a collection of license assignments with any Oracle Database product.", "operationId": "getVirtualMachines2", "summary": "Get a collection of virtual machine license assignments", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/license-requirements/virtual-machines": { "get": { "description": "Returns a collection of license requirements with any Oracle Database product.", "operationId": "getVirtualMachines3", "summary": "Get a collection of virtual machine license requirements", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations": { "get": { "description": "Returns a collection of Oracle Database installations.", "operationId": "getInstallations", "summary": "Get a collection of Database installations", "tags": [ "Installations" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}": { "get": { "description": "Returns the details of a uniquely identified Oracle Database installation.", "operationId": "getInstallations2", "summary": "Get details for a database installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/servers": { "get": { "description": "Returns a collection of servers for a uniquely identified Oracle Database installation.", "operationId": "getServers4", "summary": "Get collection of servers for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationServerCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/instances": { "get": { "description": "Returns a collection of instances for a uniquely identified Oracle Database installation.", "operationId": "getInstances", "summary": "Get a collection of instances for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationInstanceCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/options": { "get": { "description": "Returns a collection of options for a uniquely identified Oracle Database installation.", "operationId": "getOptions", "summary": "Get a collection of options for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationOptionCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/management-packs": { "get": { "description": "Returns a collection of management packs for a uniquely identified Oracle Database installation.", "operationId": "getManagementPacks", "summary": "Get a collection of management packs for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationManagementPackCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/features": { "get": { "description": "Returns a collection of features for a uniquely identified Oracle Database installation.", "operationId": "getFeatures", "summary": "Get a collection of features for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationFeatureCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/users": { "get": { "description": "Returns a collection of users for a uniquely identified Oracle Database installation.", "operationId": "getUsers", "summary": "Get a collection of users for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationUserCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/sessions": { "get": { "description": "Returns a collection of sessions for a uniquely identified Oracle Database installation.", "operationId": "getSessions", "summary": "Get a collection of sessions for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationSessionCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/installations/{id}/options/{oid}/usage": { "get": { "description": "Returns a collection of usage interpretations for a uniquely identified option and Oracle Database installation.", "operationId": "getUsage", "summary": "Get a collection of options for an installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "oid", "in": "path", "description": "The unique ID of the option.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseInstallationOptionUsageCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/java/installations": { "get": { "description": "Returns a collection of Oracle Java installations.", "operationId": "getInstallations3", "summary": "Get a collection of java installations", "tags": [ "Installations" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfJavaInstallationCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/java/installations/{id}": { "get": { "description": "Returns the details of a uniquely identified Oracle Java installation.", "operationId": "getInstallations4", "summary": "Get details of a java installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfJavaInstallationResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/java/installations/{id}/features": { "get": { "description": "Returns a collection of features for a uniquely identified Oracle Java installation.", "operationId": "getFeatures2", "summary": "Get a collection of features for a java Installation", "tags": [ "Installations" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfJavaInstallationFeatureCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/compliance/datacenters": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Middleware product.", "operationId": "getDatacenters4", "summary": "Get a collection of compliance status for any middleware product", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-assignments/datacenters": { "get": { "description": "Returns a collection of license assignments with any Oracle Middleware product.", "operationId": "getDatacenters5", "summary": "Get a collection of license assignments for any middleware product", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-requirements/datacenters": { "get": { "description": "Returns a collection of license requirements with any Oracle Middleware product.", "operationId": "getDatacenters6", "summary": "Get a collection of license requirements for any middleware product", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/compliance/servers": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Middleware product.", "operationId": "getServers5", "summary": "Get license compliance statuses for any middleware product", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-assignments/servers": { "get": { "description": "Returns a collection of license assignments with any Oracle Middleware product.", "operationId": "getServers6", "summary": "Get a collection of license compliance for middleware servers", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-requirements/servers": { "get": { "description": "Returns a collection of license requirements with any Oracle Middleware product.", "operationId": "getServers7", "summary": "Get a collection of license requirements for middleware servers", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/compliance/virtual-machines": { "get": { "description": "Returns a collection of license compliance statuses with any Oracle Middleware product.", "operationId": "getVirtualMachines4", "summary": "Get a collection of compliance status for middleware virtual machines", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateComplianceResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-assignments/virtual-machines": { "get": { "description": "Returns a collection of license assignments with any Oracle Middleware product.", "operationId": "getVirtualMachines5", "summary": "Get license assignments for middleware virtual machines", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseAssignmentResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/license-requirements/virtual-machines": { "get": { "description": "Returns a collection of license requirements with any Oracle Middleware product.", "operationId": "getVirtualMachines6", "summary": "Get license requirements for middleware virtual machines", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateLicenseRequirementResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/installations": { "get": { "description": "Returns a collection of Oracle Middleware installations.", "operationId": "getInstallations5", "summary": "Get a collection of middleware installations", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfMiddlewareInstallationCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/installations/{id}": { "get": { "description": "Returns the details of a given Oracle Middleware installation.", "operationId": "getInstallations6", "summary": "Get middleware installation", "tags": [ "Middleware" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfMiddlewareInstallationResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/installations/{id}/applications": { "get": { "description": "Returns a collection of applications for a uniquely identified Oracle Middleware installation.", "operationId": "getApplications", "summary": "Get a collection of applications for a middleware installation", "tags": [ "Middleware" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the installation.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfMiddlewareInstallationApplicationCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/entitlements/orders": { "get": { "description": "Returns a collection of Oracle orders.", "operationId": "getOrders", "summary": "Get a collection of orders", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfOrderCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/entitlements/orders/{id}": { "get": { "description": "Returns the details of a given Oracle order.", "operationId": "getOrders2", "summary": "Get order", "tags": [ "Entitlements" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the order.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/entitlements/orders/{id}/licenses": { "get": { "description": "Returns a collection of licenses for a uniquely identified Oracle order.", "operationId": "getLicenses", "summary": "Get license details of an order", "tags": [ "Entitlements" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the order.", "required": true, "schema": { "type": "string" } }, { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfLicenseCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/database/entitlements/compliance/products": { "get": { "description": "Returns a collection of Oracle Database product compliance statuses.", "operationId": "getProducts", "summary": "Get a collection of database compliance status", "tags": [ "Entitlements" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfDatabaseProductComplianceCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/middleware/entitlements/compliance/products": { "get": { "description": "Returns a collection of Oracle Middleware product compliance statuses.", "operationId": "getProducts2", "summary": "Get a collection of middleware compliance status", "tags": [ "Middleware" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfMiddlewareProductComplianceCollectionResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "401": { "description": "Unauthorized: You are not authorized to make the request. This could be because the token is expired or revoked. The recommended action is to reauthenticate and retry once.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 401, "message": "Unauthorized" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/compliance-statuses": { "get": { "description": "Returns a collection of Oracle compliance statuses.", "operationId": "getComplianceStatuses", "summary": "Get a collection of compliance status", "tags": [ "Compliance" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfComplianceStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/compliance-statuses/{id}": { "get": { "description": "Returns the details of a given Oracle compliance status.", "operationId": "getComplianceStatuses2", "summary": "Get compliance status", "tags": [ "Compliance" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the compliance status.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplianceStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/environment-types": { "get": { "description": "Returns a collection of software environment types.", "operationId": "getEnvironmentTypes", "summary": "Get a collection of environment types", "tags": [ "Environment" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEnvironmentTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/environment-types/{id}": { "get": { "description": "Returns the details of a given software environment type.", "operationId": "getEnvironmentTypes2", "summary": "Get environment type", "tags": [ "Environment" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the environment type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/estate-types": { "get": { "description": "Returns a collection of Oracle estate types.", "operationId": "getEstateTypes", "summary": "Get a collection of estate types", "tags": [ "Compliance" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfEstateTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/estate-types/{id}": { "get": { "description": "Returns details of a uniquely identified Oracle estate type.", "operationId": "getEstateTypes2", "summary": "Get estate type", "tags": [ "Compliance" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the estate type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstateTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/license-item-types": { "get": { "description": "Returns a collection of Oracle license item types.", "operationId": "getLicenseItemTypes", "summary": "Get a collection of license item types", "tags": [ "License" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfLicenseItemTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/license-item-types/{id}": { "get": { "description": "Returns the details of a given Oracle license item type.", "operationId": "getLicenseItemTypes2", "summary": "Get license item type", "tags": [ "License" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the license item type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseItemTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/license-metric-types": { "get": { "description": "Returns a collection of Oracle license metric types.", "operationId": "getLicenseMetricTypes", "summary": "Get a collection of license metric types", "tags": [ "License" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfLicenseMetricTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/license-metric-types/{id}": { "get": { "description": "Returns the details of a given Oracle license metric type.", "operationId": "getLicenseMetricTypes2", "summary": "Get license metric type", "tags": [ "License" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the license metric type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseMetricTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/licensing-types": { "get": { "description": "Returns a collection of Oracle licensing types.", "operationId": "getLicensingTypes", "summary": "Get a collection of licensing types", "tags": [ "License" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfLicensingTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/licensing-types/{id}": { "get": { "description": "Returns the details of a given Oracle licensing type.", "operationId": "getLicensingTypes2", "summary": "Get licensing type", "tags": [ "License" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the licensing type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensingTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/order-statuses": { "get": { "description": "Returns a collection of Oracle order statuses.", "operationId": "getOrderStatuses", "summary": "Get a collection of order statuses", "tags": [ "Compliance" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfOrderStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/order-statuses/{id}": { "get": { "description": "Returns details of a uniquely identified Oracle order status.", "operationId": "getOrderStatuses2", "summary": "Get order status", "tags": [ "Compliance" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the order status.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/partitioning-types": { "get": { "description": "Returns a collection of Oracle partitioning types.", "operationId": "getPartitioningTypes", "summary": "Get a collection of partitioning types", "tags": [ "Partition" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfPartitioningTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/partitioning-types/{id}": { "get": { "description": "Returns the details of a given Oracle partitioning type.", "operationId": "getPartitioningTypes2", "summary": "Get partitioning type", "tags": [ "Partition" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the partitioning type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartitioningTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/categories": { "get": { "description": "Returns a collection of Oracle product categories.", "operationId": "getCategories", "summary": "Get a collection of product categories", "tags": [ "Categories" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfProductCategoryResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/categories/{id}": { "get": { "description": "Returns the details of a given Oracle product category.", "operationId": "getCategories2", "summary": "Get product category", "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the product category.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/product-compliance-statuses": { "get": { "description": "Returns a collection of Oracle product compliance statuses.", "operationId": "getProductComplianceStatuses", "summary": "Get a collection of product compliance statuses", "tags": [ "Compliance" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfProductComplianceStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/product-compliance-statuses/{id}": { "get": { "description": "Returns the details of a given Oracle product compliance status.", "operationId": "getProductComplianceStatuses2", "summary": "Get product compliance status", "tags": [ "Compliance" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the product compliance status.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductComplianceStatusResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/products": { "get": { "description": "Returns a collection of Oracle products.", "operationId": "getProducts3", "summary": "Get a collection of products", "tags": [ "Product" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfProductResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/products/{id}": { "get": { "description": "Returns the details of a given Oracle product.", "operationId": "getProducts4", "summary": "Get product", "tags": [ "Product" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the product.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/types": { "get": { "description": "Returns a collection of Oracle product types.", "operationId": "getProductTypes", "summary": "Get a collection of product types", "tags": [ "Product" ], "parameters": [ { "name": "page_size", "description": "The maximum number of items in the response.", "in": "query", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, { "name": "page_number", "description": "The page number.", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 1 } }, { "name": "filter", "in": "query", "description": "For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).", "schema": { "type": "string", "example": "status -eq \"active\"" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredResponseWithLinksOfProductTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } }, "/api/sam/v1/oracle/types/{id}": { "get": { "description": "Returns the details of a given Oracle product type.", "operationId": "getProductTypes2", "summary": "Get product type", "tags": [ "Product" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique ID of the product type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK: Your request succeeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductTypeResponse" } } } }, "400": { "description": "Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 400, "message": "Bad Request" } } } } }, "404": { "description": "Not Found: The operation you requested failed because a resource associated with your request could not be found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 404, "message": "Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found." } } } } }, "500": { "description": "Internal Server Error: Your request failed due to an internal error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": { "code": 500, "message": "Internal Server Error" } } } } } }, "security": [ { "BearerAuth": [ "sam.oracle.r" ] } ] } } }, "components": { "schemas": { "PaginationResponse": { "type": "object", "description": "The pagination details.", "additionalProperties": false, "required": [ "page_size", "page_number" ], "properties": { "page_size": { "type": "integer", "description": "The page size you requested.", "format": "int32" }, "page_number": { "type": "integer", "description": "The page number you requested.", "format": "int32" }, "total_pages": { "type": "integer", "description": "The total number of pages.", "format": "int32", "nullable": true } } }, "Link": { "type": "object", "description": "Represents a hypermedia link referenced from a IResource, according to HATEOAS.", "additionalProperties": false, "properties": { "href": { "type": "string", "description": "The associated relative URL.", "nullable": true, "example": "sam/oracle/v1/..." }, "rel": { "type": "string", "description": "Specifies the relationship between the current document and the linked document/resource.", "nullable": true, "example": "self" }, "method": { "type": "string", "description": "The method to access related resources.", "nullable": true, "example": "GET" } } }, "BaseResponse": { "type": "object", "description": "Base response class.", "x-abstract": true, "additionalProperties": false, "required": [ "_links" ], "properties": { "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "EstateComplianceResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for estate license compliance status collection.", "additionalProperties": false, "properties": { "estateTypeId": { "type": "string", "description": "The estate type identifier.", "format": "guid", "nullable": true }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid", "nullable": true }, "datacenterId": { "type": "string", "description": "The datacenter/cluster identifier.", "format": "guid", "nullable": true }, "estateComplianceStatusId": { "type": "string", "description": "The estate compliance status identifier.", "format": "guid" } } } ] }, "FilteredResponseWithLinksOfEstateComplianceResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/EstateComplianceResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ErrorContent": { "type": "object", "description": "Contains error content.", "additionalProperties": false, "properties": { "code": { "type": "integer", "description": "The HTTP status code.", "format": "int32" }, "message": { "type": "string", "description": "The error message." } } }, "ErrorResponse": { "type": "object", "description": "Response class for errors.", "additionalProperties": false, "properties": { "error": { "description": "The error details.", "oneOf": [ { "$ref": "#/components/schemas/ErrorContent" } ] } } }, "EstateLicenseAssignmentResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for estate license assignment collection.", "additionalProperties": false, "properties": { "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "licenseMetricTypeId": { "type": "string", "description": "The license metric item type identifier.", "format": "guid", "nullable": true }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid", "nullable": true }, "datacenterId": { "type": "string", "description": "The datacenter/cluster identifier.", "format": "guid", "nullable": true }, "estateTypeId": { "type": "string", "description": "The estate type identifier.", "format": "guid", "nullable": true }, "orderId": { "type": "string", "description": "The order identifier.", "format": "guid" }, "licenseId": { "type": "string", "description": "The license identifier.", "format": "guid" }, "quantityAssigned": { "type": "integer", "description": "The assigned quantity.", "format": "int32" }, "isManualAssigned": { "type": "boolean", "description": "```true``` if Manually assigned; otherwise, ```false```." } } } ] }, "FilteredResponseWithLinksOfEstateLicenseAssignmentResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/EstateLicenseAssignmentResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "EstateLicenseRequirementResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for estate license requirement collection.", "additionalProperties": false, "properties": { "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "licenseMetricTypeId": { "type": "string", "description": "The license metric item type identifier.", "format": "guid", "nullable": true }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid", "nullable": true }, "datacenterId": { "type": "string", "description": "The datacenter/cluster identifier.", "format": "guid", "nullable": true }, "estateTypeId": { "type": "string", "description": "The estate type identifier.", "format": "guid", "nullable": true }, "requiredQuantity": { "type": "integer", "description": "The required quantity.", "format": "int32" }, "requiredQuantityDecimal": { "type": "number", "description": "The required quantity decimal.", "format": "decimal", "nullable": true }, "notAllowedLicensableEntityTypes": { "type": "string", "description": "The not allowed licensable entity types.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfEstateLicenseRequirementResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/EstateLicenseRequirementResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "databaseName": { "type": "string", "description": "The database name.", "nullable": true }, "productVersion": { "type": "string", "description": "The product version.", "nullable": true }, "isRac": { "type": "boolean", "description": "```true``` if This is a Real Application Cluster (RAC) database; otherwise, ```false```.", "nullable": true }, "isDataGuard": { "type": "boolean", "description": "```true``` if Oracle Data Guard is configured; otherwise, ```false```.", "nullable": true }, "scanDate": { "type": "string", "description": "The scan date.", "format": "date-time" } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationManagementPacksSummaryResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation management pack summary collection.", "additionalProperties": false, "properties": { "isOemReposPrior10G": { "type": "boolean", "description": "```true``` if The em epos rior10 condition is met; otherwise, ```false```.", "nullable": true }, "isOemProgPrior10G": { "type": "boolean", "description": "```true``` if The em rog rior10 condition is met; otherwise, ```false```.", "nullable": true }, "isOemRepos10GAndHigher": { "type": "boolean", "description": "```true``` if The em epos10 nd igher condition is met; otherwise, ```false```.", "nullable": true }, "isOemPackGrant": { "type": "boolean", "description": "```true``` if Access is granted; otherwise, ```false```.", "nullable": true }, "isOemPackAgree": { "type": "boolean", "description": "```true``` if The agreement is accepted; otherwise, ```false```.", "nullable": true }, "isOemManagedTargets": { "type": "boolean", "description": "```true``` if The em anaged argets condition is met; otherwise, ```false```.", "nullable": true }, "isDbControl10GPackGrant": { "type": "boolean", "description": "```true``` if Access is granted; otherwise, ```false```.", "nullable": true }, "isDbControl10GPackAgree": { "type": "boolean", "description": "```true``` if The agreement is accepted; otherwise, ```false```.", "nullable": true }, "managementPackAccess11G": { "type": "string", "description": "The management pack access 11G.", "nullable": true }, "isSqlProfilesUsed": { "type": "boolean", "description": "```true``` if The option is used; otherwise, ```false```.", "nullable": true } } } ] }, "DatabaseInstallationResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "identifier": { "type": "string", "description": "The identifier.", "nullable": true }, "productVersion": { "type": "string", "description": "The product version.", "nullable": true }, "databaseName": { "type": "string", "description": "The database name.", "nullable": true }, "databaseUniqueName": { "type": "string", "description": "The database unique name.", "nullable": true }, "databaseDomain": { "type": "string", "description": "The database domain.", "nullable": true }, "globalName": { "type": "string", "description": "The global name.", "nullable": true }, "mode": { "type": "string", "description": "The mode.", "nullable": true }, "scanDate": { "type": "string", "description": "The scan date.", "format": "date-time" }, "processorsAssigned": { "type": "integer", "description": "The processors assigned.", "format": "int32", "nullable": true }, "cpuSocketCount": { "type": "integer", "description": "The cpu socket count.", "format": "int32", "nullable": true }, "cpuCoreCount": { "type": "integer", "description": "The cpu core count.", "format": "int32", "nullable": true }, "cpuHighWater": { "type": "integer", "description": "The cpu high-water.", "format": "int32", "nullable": true }, "cpuCoreHighWater": { "type": "integer", "description": "The cpu core high-water.", "format": "int32", "nullable": true }, "isManagedByOEM": { "type": "boolean", "description": "```true``` if This database is managed by Oracle Enterprise Manager (OEM); otherwise, ```false```.", "nullable": true }, "isVaultInstalled": { "type": "boolean", "description": "```true``` if Oracle Key Vault is installed; otherwise, ```false```.", "nullable": true }, "isVaultUsed": { "type": "boolean", "description": "```true``` if Oracle Key Vault is used; otherwise, ```false```.", "nullable": true }, "maxMemoryUsed": { "type": "integer", "description": "The max memory used.", "format": "int64", "nullable": true }, "isNoInventory": { "type": "boolean", "description": "```true``` if No inventory data is available; otherwise, ```false```." }, "isUsedBy3PP": { "type": "boolean", "description": "```true``` if This database is used by third-party products; otherwise, ```false```.", "nullable": true }, "failOverClient": { "type": "string", "description": "The failover client.", "nullable": true }, "failOverServer": { "type": "string", "description": "The failover server.", "nullable": true }, "isDataGuard": { "type": "boolean", "description": "```true``` if Oracle Data Guard is configured; otherwise, ```false```.", "nullable": true }, "logArchiveConfig": { "type": "string", "description": "The log archive config.", "nullable": true }, "databaseRole": { "type": "string", "description": "The database role.", "nullable": true }, "openMode": { "type": "string", "description": "The open mode.", "nullable": true }, "switchoverStatus": { "type": "string", "description": "The switchover status.", "nullable": true }, "protectionMode": { "type": "string", "description": "The protection mode.", "nullable": true }, "isRac": { "type": "boolean", "description": "```true``` if This is a Real Application Cluster (RAC) database; otherwise, ```false```.", "nullable": true }, "isRMANDB": { "type": "boolean", "description": "```true``` if The condition is met; otherwise, ```false```.", "nullable": true }, "isOEMDB": { "type": "boolean", "description": "```true``` if OEM is configured; otherwise, ```false```.", "nullable": true }, "isCDB": { "type": "boolean", "description": "```true``` if This is a Container Database (CDB); otherwise, ```false```.", "nullable": true }, "isPDB": { "type": "boolean", "description": "```true``` if This is a Pluggable Database (PDB); otherwise, ```false```.", "nullable": true }, "numberOfInstances": { "type": "integer", "description": "The number of instances.", "format": "int32", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time", "nullable": true }, "oracleDBID": { "type": "string", "description": "The oracle DBID.", "nullable": true }, "cdbDBID": { "type": "string", "description": "The cdb DBID.", "nullable": true }, "summary": { "description": "The summary.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DatabaseInstallationManagementPacksSummaryResponse" } ] } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationServerCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation server collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation server.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "licensingCoreFactor": { "type": "number", "description": "The licensing core factor.", "format": "decimal" } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationServerCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationServerCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationInstanceCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation instance collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation instance.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "instanceName": { "type": "string", "description": "The instance name.", "nullable": true }, "hostName": { "type": "string", "description": "The host name.", "nullable": true }, "numberOfProcessorsAssigned": { "type": "integer", "description": "The mumber of processors assigned.", "format": "int32", "nullable": true }, "cpuCoreCount": { "type": "integer", "description": "The cpu core count.", "format": "int32", "nullable": true }, "cpuSocketCount": { "type": "integer", "description": "The cpu socket count.", "format": "int32", "nullable": true }, "cpuHighwater": { "type": "integer", "description": "The cpu high-water.", "format": "int32", "nullable": true }, "cpuCoreHighwater": { "type": "integer", "description": "The cpu core high-water.", "format": "int32", "nullable": true }, "cpuSocketHighwater": { "type": "integer", "description": "The cpu socket high-water.", "format": "int32", "nullable": true }, "instanceId": { "type": "string", "description": "The instance identifier.", "format": "guid" } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationInstanceCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationInstanceCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationOptionCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation option collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation option.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "tableOwner": { "type": "string", "description": "The table owner.", "nullable": true }, "isInstalled": { "type": "boolean", "description": "```true``` if The option is installed; otherwise, ```false```." }, "isUsed": { "type": "boolean", "description": "```true``` if The option is used; otherwise, ```false```." }, "lastUsed": { "type": "string", "description": "The last used.", "format": "date-time", "nullable": true }, "firstUsed": { "type": "string", "description": "The first used.", "format": "date-time", "nullable": true }, "detectedUsages": { "type": "integer", "description": "The detected usages.", "format": "int32", "nullable": true } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationOptionCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationOptionCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationManagementPackCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation management pack collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation management pack.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "isInstalled": { "type": "boolean", "description": "```true``` if The option is installed; otherwise, ```false```." }, "isUsed": { "type": "boolean", "description": "```true``` if The option is used; otherwise, ```false```." }, "oraclePackUser": { "type": "string", "description": "The oracle pack user.", "nullable": true }, "oracleOemDate": { "type": "string", "description": "The oracle OEM date.", "format": "date-time", "nullable": true }, "isPackAccessGranted": { "type": "boolean", "description": "```true``` if Access is granted; otherwise, ```false```.", "nullable": true }, "isPackAccessAgreed": { "type": "boolean", "description": "```true``` if The agreement is accepted; otherwise, ```false```.", "nullable": true }, "packAccessAgreedDate": { "type": "string", "description": "The pack access agreed date.", "format": "date-time", "nullable": true }, "packAccessAgreedBy": { "type": "string", "description": "The pack access agreed by.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationManagementPackCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationManagementPackCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationFeatureCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation feature collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation feature.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "name": { "type": "string", "description": "The name.", "nullable": true }, "isUsed": { "type": "boolean", "description": "```true``` if The option is used; otherwise, ```false```.", "nullable": true }, "firstUsed": { "type": "string", "description": "The first used.", "format": "date-time", "nullable": true }, "lastUsed": { "type": "string", "description": "The last used.", "format": "date-time", "nullable": true }, "description": { "type": "string", "description": "The description.", "nullable": true }, "detectedUsages": { "type": "integer", "description": "The detected usages.", "format": "int32", "nullable": true } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationFeatureCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationFeatureCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationUserCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation user collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation user.", "format": "guid" }, "userName": { "type": "string", "description": "The user name.", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time", "nullable": true }, "expireDate": { "type": "string", "description": "The expire date.", "format": "date-time" }, "accountStatus": { "type": "string", "description": "The account status.", "nullable": true }, "lockDate": { "type": "string", "description": "The lock date.", "format": "date-time", "nullable": true } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationUserCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationUserCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationSessionCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation session collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation session.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "sessionId": { "type": "string", "description": "The session identifier.", "format": "guid" }, "osUser": { "type": "string", "description": "The os user.", "nullable": true }, "clientProgram": { "type": "string", "description": "The client program.", "nullable": true }, "oracleUser": { "type": "string", "description": "The oracle user.", "nullable": true }, "logonTime": { "type": "string", "description": "The logon date.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "The status.", "nullable": true }, "isBackgroundSession": { "type": "boolean", "description": "```true``` if This is a background session; otherwise, ```false```.", "nullable": true }, "machine": { "type": "string", "description": "The machine.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationSessionCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationSessionCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "DatabaseInstallationOptionUsageFactEntity": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation option usage fact.", "additionalProperties": false, "properties": { "factName": { "type": "string", "description": "The fact name.", "nullable": true }, "factValues": { "type": "string", "description": "The fact values.", "nullable": true } } } ] }, "DatabaseInstallationOptionUsageQueriesEntity": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation option usage query.", "additionalProperties": false, "properties": { "queryName": { "type": "string", "description": "The query name.", "nullable": true }, "isUsageTriggered": { "type": "boolean", "description": "```true``` if Usage is triggered; otherwise, ```false```." }, "usageFacts": { "type": "array", "description": "The usage facts.", "nullable": true, "items": { "$ref": "#/components/schemas/DatabaseInstallationOptionUsageFactEntity" } } } } ] }, "DatabaseInstallationOptionUsageCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for database installation option usage collection.", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "The unique ID of the database installation option usage.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "groupName": { "type": "string", "description": "The group name.", "nullable": true }, "isUsageTriggered": { "type": "boolean", "description": "```true``` if Usage is triggered; otherwise, ```false```." }, "usageQueries": { "type": "array", "description": "The usage queries.", "nullable": true, "items": { "$ref": "#/components/schemas/DatabaseInstallationOptionUsageQueriesEntity" } } } } ] }, "FilteredResponseWithLinksOfDatabaseInstallationOptionUsageCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseInstallationOptionUsageCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "JavaInstallationCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for java installation collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the Java installation.", "format": "guid", "minLength": 1 }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid", "nullable": true }, "runtimeName": { "type": "string", "description": "The runtime name.", "nullable": true }, "runtimeVersion": { "type": "string", "description": "The runtime version.", "nullable": true }, "vendor": { "type": "string", "description": "The vendor.", "nullable": true }, "version": { "type": "string", "description": "The version.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfJavaInstallationCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/JavaInstallationCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "JavaInstallationResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for java installation.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the Java installation.", "format": "guid", "minLength": 1 }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid", "nullable": true }, "dataModel": { "type": "integer", "description": "The data model.", "format": "int32" }, "classVersion": { "type": "string", "description": "The class version.", "nullable": true }, "home": { "type": "string", "description": "The home.", "nullable": true }, "runtimeName": { "type": "string", "description": "The runtime name.", "nullable": true }, "runtimeVersion": { "type": "string", "description": "The runtime version.", "nullable": true }, "specificationName": { "type": "string", "description": "The specification name.", "nullable": true }, "specificationVendor": { "type": "string", "description": "The specification vendor.", "nullable": true }, "specificationVersion": { "type": "string", "description": "The specification version.", "nullable": true }, "vendor": { "type": "string", "description": "The vendor.", "nullable": true }, "vendorUrl": { "type": "string", "description": "The vendor url.", "nullable": true }, "version": { "type": "string", "description": "The version.", "nullable": true }, "vmName": { "type": "string", "description": "The VM name.", "nullable": true }, "vmSpecificationVendor": { "type": "string", "description": "The VM specification vendor.", "nullable": true }, "vmSpecificationVersion": { "type": "string", "description": "The VM specification version.", "nullable": true }, "vmVersion": { "type": "string", "description": "The VM version.", "nullable": true }, "userHome": { "type": "string", "description": "The user home.", "nullable": true }, "userName": { "type": "string", "description": "The user name.", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time" }, "updatedDate": { "type": "string", "description": "The updated date.", "format": "date-time", "nullable": true } } } ] }, "FilteredResponseWithLinksOfJavaInstallationResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/JavaInstallationResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "JavaInstallationFeatureCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for java installation features collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the Java installation feature.", "format": "guid", "minLength": 1 }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "featureId": { "type": "string", "description": "The feature identifier.", "format": "guid" }, "name": { "type": "string", "description": "The name.", "nullable": true }, "status": { "type": "string", "description": "The status.", "nullable": true }, "version": { "type": "string", "description": "The version.", "nullable": true }, "vendor": { "type": "string", "description": "The vendor.", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time" }, "updatedDate": { "type": "string", "description": "The updated date.", "format": "date-time", "nullable": true } } } ] }, "FilteredResponseWithLinksOfJavaInstallationFeatureCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/JavaInstallationFeatureCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "MiddlewareInstallationCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for middleware installation collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the middleware installation.", "format": "guid", "minLength": 1 }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "version": { "type": "string", "description": "The version.", "nullable": true }, "oracleHomePath": { "type": "string", "description": "The Oracle home path.", "nullable": true }, "firstDiscovered": { "type": "string", "description": "The first discovered date.", "format": "date-time" } } } ] }, "FilteredResponseWithLinksOfMiddlewareInstallationCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/MiddlewareInstallationCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "MiddlewareInstallationResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for middleware installation.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the middleware installation.", "format": "guid", "minLength": 1 }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid" }, "version": { "type": "string", "description": "The version.", "nullable": true }, "oracleHomePath": { "type": "string", "description": "The Oracle home path.", "nullable": true }, "firstDiscovered": { "type": "string", "description": "The first discovered date.", "format": "date-time" } } } ] }, "FilteredResponseWithLinksOfMiddlewareInstallationResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/MiddlewareInstallationResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "MiddlewareInstallationApplicationCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for middleware installation applications collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the middleware installation application.", "format": "guid", "minLength": 1 }, "version": { "type": "string", "description": "The version.", "nullable": true }, "name": { "type": "string", "description": "The name.", "nullable": true }, "parentId": { "type": "string", "description": "The parent unique identifier.", "format": "guid" }, "applicationId": { "type": "string", "description": "The application identifier.", "format": "guid" } } } ] }, "FilteredResponseWithLinksOfMiddlewareInstallationApplicationCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/MiddlewareInstallationApplicationCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "OrderCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for order collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the order.", "format": "guid", "minLength": 1 }, "orderDate": { "type": "string", "description": "The order date.", "format": "date-time" }, "orderName": { "type": "string", "description": "The order name.", "nullable": true }, "oracleOrderNumber": { "type": "string", "description": "The oracle order number.", "nullable": true }, "olsa": { "type": "string", "description": "The olsa.", "nullable": true }, "areaOfUse": { "type": "string", "description": "The area of use.", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time" } } } ] }, "FilteredResponseWithLinksOfOrderCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/OrderCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "OrderResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for order.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the order.", "format": "guid", "minLength": 1 }, "orderDate": { "type": "string", "description": "The order date.", "format": "date-time" }, "orderName": { "type": "string", "description": "The order name.", "nullable": true }, "oracleOrderNumber": { "type": "string", "description": "The oracle order number.", "nullable": true }, "resellerOrderNumber": { "type": "string", "description": "The reseller order number.", "nullable": true }, "internalReferenceNumber": { "type": "string", "description": "The internal reference number.", "nullable": true }, "olsa": { "type": "string", "description": "The olsa.", "nullable": true }, "purchaseCurrency": { "type": "string", "description": "The purchase currency.", "nullable": true }, "areaOfUse": { "type": "string", "description": "The area of use.", "nullable": true }, "notes": { "type": "string", "description": "The notes.", "nullable": true }, "organizationId": { "type": "string", "description": "The Organization identifier.", "format": "guid" }, "contactName": { "type": "string", "description": "The contact name.", "nullable": true }, "contactEmail": { "type": "string", "description": "The contact email.", "nullable": true }, "contactPhone": { "type": "string", "description": "The contact phone.", "nullable": true }, "vendorName": { "type": "string", "description": "The vendor name.", "nullable": true }, "vendorAddress": { "type": "string", "description": "The vendor address.", "nullable": true }, "vendorContact": { "type": "string", "description": "The vendor contact.", "nullable": true }, "vendorEmail": { "type": "string", "description": "The vendor email.", "nullable": true }, "vendorPhone": { "type": "string", "description": "The vendor phone.", "nullable": true }, "createdDate": { "type": "string", "description": "The created date.", "format": "date-time" }, "updatedDate": { "type": "string", "description": "The updated date.", "format": "date-time" }, "orderStatusId": { "type": "string", "description": "The order status identifier.", "format": "guid", "nullable": true } } } ] }, "LicenseCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for license collection.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the license.", "format": "guid", "minLength": 1 }, "orderId": { "type": "string", "description": "The order identifier.", "format": "guid" }, "licenseType": { "type": "string", "description": "The license item type.", "nullable": true }, "referstoItemId": { "type": "string", "description": "The refers to item identifier.", "format": "guid", "nullable": true }, "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "licenseTypeId": { "type": "string", "description": "The license type.", "format": "guid", "nullable": true }, "licenseMetricTypeId": { "type": "string", "description": "The license metric type identifier.", "format": "guid", "nullable": true }, "quantity": { "type": "integer", "description": "The quantity.", "format": "int32" }, "licenseCost": { "type": "number", "description": "The license cost.", "format": "decimal", "nullable": true }, "licenseCostBase": { "type": "number", "description": "The license cost base.", "format": "decimal", "nullable": true }, "supportCost": { "type": "number", "description": "The support cost.", "format": "decimal", "nullable": true }, "supportCostBase": { "type": "number", "description": "The support cost base.", "format": "decimal", "nullable": true }, "csi": { "type": "string", "description": "The SCI.", "nullable": true }, "supportContractId": { "type": "integer", "description": "The support contract identifier.", "format": "int32", "nullable": true }, "isPerpertual": { "type": "boolean", "description": "```true``` if The erpertual condition is met; otherwise, ```false```." }, "nonPerpertualYears": { "type": "integer", "description": "The non perpetual years.", "format": "int32", "nullable": true } } } ] }, "FilteredResponseWithLinksOfLicenseCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/LicenseCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "BaseProductComplianceCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Base response class for product compliance collection.", "additionalProperties": false, "properties": { "productId": { "type": "string", "description": "The product identifier.", "format": "guid" }, "estateTypeId": { "type": "string", "description": "The estate type identifier.", "format": "guid", "nullable": true }, "estateName": { "type": "string", "description": "The estate name.", "nullable": true }, "computerId": { "type": "string", "description": "The computer identifier.", "format": "guid", "nullable": true }, "datacenterId": { "type": "string", "description": "The datacenter/cluster identifier.", "format": "guid", "nullable": true }, "isLicenseRequired": { "type": "boolean", "description": "```true``` if A license is required; otherwise, ```false```." }, "totalAssignedLicenseProcessor": { "type": "integer", "description": "The total assigned license per processor metric.", "format": "int32" }, "totalRequiredLicenseProcessor": { "type": "integer", "description": "The total required license per processor metric.", "format": "int32" }, "totalAssignedLicenseNup": { "type": "integer", "description": "The total assigned license per NUP metric.", "format": "int32" }, "totalRequiredLicenseNup": { "type": "integer", "description": "The total required license per NUP metric.", "format": "int32" }, "allInstallationsCount": { "type": "integer", "description": "The installations count.", "format": "int32" }, "installationsRequiredLicenseCount": { "type": "integer", "description": "The count of installations that require license.", "format": "int32" }, "installationsNotRequiredLicenseCount": { "type": "integer", "description": "The count of installations that not require license.", "format": "int32" }, "licenseMetricTypeId": { "type": "string", "description": "The license metric item type identifier.", "format": "guid", "nullable": true }, "productComplianceStatusId": { "type": "string", "description": "The estate compliance status identifier.", "format": "guid", "nullable": true }, "coveredByProductId": { "type": "string", "description": "The covered by product identifier.", "format": "guid", "nullable": true }, "coveredByEstate": { "type": "string", "description": "The covered by estate name.", "nullable": true }, "licenseNeeded": { "type": "integer", "description": "The license needed.", "format": "int32" }, "partitioningTypeId": { "type": "string", "description": "The partitioning type identifier.", "format": "guid", "nullable": true } } } ] }, "DatabaseProductComplianceCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseProductComplianceCollectionResponse" }, { "type": "object", "description": "Response class for database product compliance collection.", "additionalProperties": false } ] }, "FilteredResponseWithLinksOfDatabaseProductComplianceCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/DatabaseProductComplianceCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "MiddlewareProductComplianceCollectionResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseProductComplianceCollectionResponse" }, { "type": "object", "description": "Response class for middleware product compliance collection.", "additionalProperties": false } ] }, "FilteredResponseWithLinksOfMiddlewareProductComplianceCollectionResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/MiddlewareProductComplianceCollectionResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ComplianceStatusResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for compliance status.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the compliance status.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfComplianceStatusResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/ComplianceStatusResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "EnvironmentTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for environment type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the environment type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfEnvironmentTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/EnvironmentTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "EstateTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for estate type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the estate type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfEstateTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/EstateTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "LicenseItemTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for license item type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the license item type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfLicenseItemTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/LicenseItemTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "LicenseMetricTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for license metric type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the license metric type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfLicenseMetricTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/LicenseMetricTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "LicensingTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for licensing type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the licensing type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfLicensingTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/LicensingTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "OrderStatusResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for order status.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the order status.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfOrderStatusResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/OrderStatusResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "PartitioningTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for partitioning type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the partitioning type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfPartitioningTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/PartitioningTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ProductCategoryResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for product category.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the product category.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfProductCategoryResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/ProductCategoryResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ProductComplianceStatusResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for product compliance status.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the product compliance status.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfProductComplianceStatusResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/ProductComplianceStatusResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ProductResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for product.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the product.", "format": "guid", "minLength": 1 }, "parentId": { "type": "string", "description": "The parent product identifier.", "format": "guid", "nullable": true }, "categoryId": { "type": "string", "description": "The product category identifier.", "format": "guid", "nullable": true }, "productTypeId": { "type": "string", "description": "The product type identifier.", "format": "guid", "nullable": true }, "licensingTypeId": { "type": "string", "description": "The licensing type identifier.", "format": "guid", "nullable": true }, "productName": { "type": "string", "description": "The product name.", "nullable": true }, "productEdition": { "type": "string", "description": "The product edition.", "nullable": true }, "acronym": { "type": "string", "description": "The acronym.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfProductResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/ProductResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } }, "ProductTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/BaseResponse" }, { "type": "object", "description": "Response class for product type.", "additionalProperties": false, "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The unique ID of the product type.", "format": "guid", "minLength": 1 }, "name": { "type": "string", "description": "The name.", "nullable": true } } } ] }, "FilteredResponseWithLinksOfProductTypeResponse": { "type": "object", "additionalProperties": false, "required": [ "items", "pagination", "_links" ], "properties": { "items": { "type": "array", "description": "A collection of items.", "items": { "$ref": "#/components/schemas/ProductTypeResponse" } }, "pagination": { "description": "The pagination details.", "oneOf": [ { "$ref": "#/components/schemas/PaginationResponse" } ] }, "_links": { "type": "array", "description": "A collection of links to related resources.", "items": { "$ref": "#/components/schemas/Link" } } } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }