All URIs are relative to https://eu1.data.cloud.hpe.com
| Method | HTTP request | Description |
|---|---|---|
| get_issue | GET /api/v1/issues/{id} | Returns the active issue with the given Id |
| list_issues | GET /api/v1/issues | Returns a list of active issues associated with the account, scoped by the user's permissions |
IssueDetails get_issue(id)
Returns the active issue with the given Id
Returns the active issue (state="CREATED") associated with the account (retrieved from the request headers) and with given Id
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import issues_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.issue_details import IssueDetails
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
host = "https://eu1.data.cloud.hpe.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = issues_api.IssuesApi(api_client)
id = "id_example" # str | The UUID of the issue
select = "select_example" # str | The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas. (optional)
# example passing only required values which don't have defaults set
try:
# Returns the active issue with the given Id
api_response = api_instance.get_issue(id)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling IssuesApi->get_issue: %s\n" % e)
# example passing only required values which don't have defaults set
# and optional values
try:
# Returns the active issue with the given Id
api_response = api_instance.get_issue(id, select=select)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling IssuesApi->get_issue: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the issue | |
| select | str | The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Details of the issue with the given Id | - |
| 400 | Bad/Malformed request | - |
| 401 | Unauthenticated request | - |
| 403 | Unauthorized request | - |
| 404 | Issue with the given Id does not exist | - |
| 405 | Method not supported | - |
| 409 | Issue is not active | - |
| 422 | Unprocessable input request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IssuesList list_issues()
Returns a list of active issues associated with the account, scoped by the user's permissions
Returns the active (state="CREATED") issues for the account, which are associated with the resource-types for which the user has access. The user should also have the permission to view issues. Eg: if there are issues associated with 50 resources (of different resource-types) for a customer (obtained from the request header), and the user (obtained from the request headers), who has correct permissions to view the issues but has acceess to only 20 of those resources (ie access to their resource types), this API will return only the issues associated with those 20 resources. The grouped issues are places next to each other. The client will have to process them for any desired grouping
- Bearer (JWT) Authentication (JWTAuth):
import time
import greenlake_data_services
from greenlake_data_services.api import issues_api
from greenlake_data_services.model.error_response import ErrorResponse
from greenlake_data_services.model.issues_list import IssuesList
from pprint import pprint
# Defining the host is optional and defaults to https://eu1.data.cloud.hpe.com
# See configuration.py for a list of all supported configuration parameters.
configuration = greenlake_data_services.Configuration(
host = "https://eu1.data.cloud.hpe.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): JWTAuth
configuration = greenlake_data_services.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with greenlake_data_services.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = issues_api.IssuesApi(api_client)
offset = 1 # int | The number of items to skip before starting to collect the result set (optional)
limit = 1 # int | The numbers of items to return (optional)
filter = "filter_example" # str | The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter A comparision compares a property name to a literal. The comparisons supported are the following: “eq” : Is a property equal to value. Valid for number, boolean and string properties. “gt” : Is a property greater than a value. Valid for number or string timestamp properties. “lt” : Is a property less than a value. Valid for number or string timestamp properties “in” : Is a value in a property (that is an array of strings) Syntax: “eq” : filter=<property> eq <value> {host:port}/api/v1/issues?filter=<property> eq <value> “gt” : filter=<property> gt <value> {host:port}/api/v1/issues?filter=<property> gt <value> “lt” : filter=<property> lt <value> {host:port}/api/v1/issues?filter=<property> lt <value> “in” : filter=<property> in <value> {host:port}/api/v1/issues?filter=<property> in <value> * Can use and to add more filter inputs {host:port}/api/v1/issues?filter=<property1> eq <value1> and <property2> lt <value2> * To filter multiple values on one property e.g. filter=severity in ('CRITICAL','WARNING') {host:port}/api/v1/issues?filter=severity%20in%20CRITICAL%2CWARNING Examples: GET /api/v1/issues?filter=issueType eq 'ISSUE' GET /api/v1/issues?filter=issueType eq 'ISSUE' and state eq 'CREATED' GET /api/v1/issues?filter=relatedObjectType in ('NIMBLE-VOLUME') Filters are supported on following attributes: issueType, severity, category, state, relatedObject (relatedObject.resourceUri), relatedObjectType (relatedObject.type), relatedObjectOwner (relatedObjectOwner.resourceUri), relatedObjectOwnerType (relatedObjectOwner.type), ruleId, createdAt (optional)
sort = "/issues?sort=id desc" # str | resource property to sort, with an order appended Order may only be either “asc” (ascending) or “desc” (descending) (optional)
select = "select_example" # str | The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas. (optional)
# example passing only required values which don't have defaults set
# and optional values
try:
# Returns a list of active issues associated with the account, scoped by the user's permissions
api_response = api_instance.list_issues(offset=offset, limit=limit, filter=filter, sort=sort, select=select)
pprint(api_response)
except greenlake_data_services.ApiException as e:
print("Exception when calling IssuesApi->list_issues: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| offset | int | The number of items to skip before starting to collect the result set | [optional] |
| limit | int | The numbers of items to return | [optional] |
| filter | str | The filter query parameter is used to filter the set of resources returned in the response. The returned set of resources must match the criteria in the filter query parameter A comparision compares a property name to a literal. The comparisons supported are the following: “eq” : Is a property equal to value. Valid for number, boolean and string properties. “gt” : Is a property greater than a value. Valid for number or string timestamp properties. “lt” : Is a property less than a value. Valid for number or string timestamp properties “in” : Is a value in a property (that is an array of strings) Syntax: “eq” : filter=<property> eq <value> {host:port}/api/v1/issues?filter=<property> eq <value> “gt” : filter=<property> gt <value> {host:port}/api/v1/issues?filter=<property> gt <value> “lt” : filter=<property> lt <value> {host:port}/api/v1/issues?filter=<property> lt <value> “in” : filter=<property> in <value> {host:port}/api/v1/issues?filter=<property> in <value> * Can use and to add more filter inputs {host:port}/api/v1/issues?filter=<property1> eq <value1> and <property2> lt <value2> * To filter multiple values on one property e.g. filter=severity in ('CRITICAL','WARNING') {host:port}/api/v1/issues?filter=severity%20in%20CRITICAL%2CWARNING Examples: GET /api/v1/issues?filter=issueType eq 'ISSUE' GET /api/v1/issues?filter=issueType eq 'ISSUE' and state eq 'CREATED' GET /api/v1/issues?filter=relatedObjectType in ('NIMBLE-VOLUME') Filters are supported on following attributes: issueType, severity, category, state, relatedObject (relatedObject.resourceUri), relatedObjectType (relatedObject.type), relatedObjectOwner (relatedObjectOwner.resourceUri), relatedObjectOwnerType (relatedObjectOwner.type), ruleId, createdAt | [optional] |
| sort | str | resource property to sort, with an order appended Order may only be either “asc” (ascending) or “desc” (descending) | [optional] |
| select | str | The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas. | [optional] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Issues list | - |
| 400 | Bad/Malformed request | - |
| 401 | Unauthenticated request | - |
| 403 | Unauthorized request | - |
| 404 | The filter attribute's value does not exist | - |
| 405 | Method not supported | - |
| 422 | Unprocessable input request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]