Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 6.25 KB

ResourcesApi.md

File metadata and controls

133 lines (99 loc) · 6.25 KB

ResourcesApi

All URIs are relative to http://127.0.0.1:8700/

Method HTTP request Description
portalresources_get GET /portalresources Retrieve a listing and description of available resources for portal
resources_get GET /resources Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.

portalresources_get

Resources portalresources_get(graph_format, level=level, force_refresh=force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)

Retrieve a listing and description of available resources for portal

Retrieve a listing and description of available resources for portal

Example

from __future__ import print_function
import time
from fabric_cf.orchestrator.swagger_client import ResourcesApi, Configuration, ApiClient
from fabric_cf.orchestrator.swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = ResourcesApi()
graph_format = 'GRAPHML' # str | graph format (default to GRAPHML)
level = 1 # int | Level of details (optional) (default to 1)
force_refresh = false # bool | Force to retrieve current available resource information. (optional) (default to false)
start_date = 'start_date_example' # str | starting date to check availability from (optional)
end_date = 'end_date_example' # str | end date to check availability until (optional)
includes = 'includes_example' # str | comma separated lists of sites to include (optional)
excludes = 'excludes_example' # str | comma separated lists of sites to exclude (optional)

try:
    # Retrieve a listing and description of available resources for portal
    api_response = api_instance.portalresources_get(graph_format, level=level, force_refresh=force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesApi->portalresources_get: %s\n" % e)

Parameters

Name Type Description Notes
graph_format str graph format [default to GRAPHML]
level int Level of details [optional] [default to 1]
force_refresh bool Force to retrieve current available resource information. [optional] [default to false]
start_date str starting date to check availability from [optional]
end_date str end date to check availability until [optional]
includes str comma separated lists of sites to include [optional]
excludes str comma separated lists of sites to exclude [optional]

Return type

Resources

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resources_get

Resources resources_get(level, force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)

Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.

Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.

Example

from __future__ import print_function
import time
from fabric_cf.orchestrator.swagger_client import ResourcesApi, Configuration, ApiClient
from fabric_cf.orchestrator.swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = ResourcesApi(ApiClient(configuration))
level = 1 # int | Level of details (default to 1)
force_refresh = False # bool | Force to retrieve current available resource information. (default to false)
start_date = 'start_date_example' # str | starting date to check availability from (optional)
end_date = 'end_date_example' # str | end date to check availability until (optional)
includes = 'includes_example' # str | comma separated lists of sites to include (optional)
excludes = 'excludes_example' # str | comma separated lists of sites to exclude (optional)

try:
    # Retrieve a listing and description of available resources. By default, a cached available resource information is returned. User can force to request the current available resources.
    api_response = api_instance.resources_get(level, force_refresh, start_date=start_date, end_date=end_date, includes=includes, excludes=excludes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourcesApi->resources_get: %s\n" % e)

Parameters

Name Type Description Notes
level int Level of details [default to 1]
force_refresh bool Force to retrieve current available resource information. [default to false]
start_date str starting date to check availability from [optional]
end_date str end date to check availability until [optional]
includes str comma separated lists of sites to include [optional]
excludes str comma separated lists of sites to exclude [optional]

Return type

Resources

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]