Skip to content

plantscreen.BufferApi

All URIs are relative to https://localhost:44339

Method HTTP request Description
buffer_history GET /Buffer/History Returns one buffer history state defined by buffer state ID.
buffer_history_date GET /Buffer/History/Date Returns buffer history states between times. Times is entered as the start and end time of the required interval.

buffer_history

JsonBufferHistoryResult buffer_history(id)

Returns one buffer history state defined by buffer state ID.

Example

import plantscreen
from plantscreen.models.json_buffer_history_result import JsonBufferHistoryResult
from plantscreen.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost:44339
# See configuration.py for a list of all supported configuration parameters.
configuration = plantscreen.Configuration(
    host = "https://localhost:44339"
)


# Enter a context with an instance of the API client
with plantscreen.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = plantscreen.BufferApi(api_client)
    id = 56 # int | bufferStateID

    try:
        # Returns one buffer history state defined by buffer state ID.
        api_response = api_instance.buffer_history(id)
        print("The response of BufferApi->buffer_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BufferApi->buffer_history: %s\n" % e)

Parameters

Name Type Description Notes
id int bufferStateID

Return type

JsonBufferHistoryResult

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] Back to API Endpoints Back to Models [Back to README]

buffer_history_date

JsonBufferHistoryByDateResult buffer_history_date(start, stop)

Returns buffer history states between times. Times is entered as the start and end time of the required interval.

Example

import plantscreen
from plantscreen.models.json_buffer_history_by_date_result import JsonBufferHistoryByDateResult
from plantscreen.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost:44339
# See configuration.py for a list of all supported configuration parameters.
configuration = plantscreen.Configuration(
    host = "https://localhost:44339"
)


# Enter a context with an instance of the API client
with plantscreen.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = plantscreen.BufferApi(api_client)
    start = '2013-10-20T19:20:30+01:00' # datetime | dateStart
    stop = '2013-10-20T19:20:30+01:00' # datetime | dateStop

    try:
        # Returns buffer history states between times. Times is entered as the start and end time of the required interval.
        api_response = api_instance.buffer_history_date(start, stop)
        print("The response of BufferApi->buffer_history_date:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BufferApi->buffer_history_date: %s\n" % e)

Parameters

Name Type Description Notes
start datetime dateStart
stop datetime dateStop

Return type

JsonBufferHistoryByDateResult

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

[Back to top] Back to API Endpoints Back to Models [Back to README]