Skip to content

Latest commit

 

History

History
467 lines (337 loc) · 23.1 KB

PlantBatchesApi.md

File metadata and controls

467 lines (337 loc) · 23.1 KB

t3api.PlantBatchesApi

All URIs are relative to https://api.trackandtrace.tools

Method HTTP request Description
v2_plantbatches_active_get GET /v2/plantbatches/active List of active plant batches
v2_plantbatches_active_report_get GET /v2/plantbatches/active/report Generate a report of all active plant batches
v2_plantbatches_history_get GET /v2/plantbatches/history List of history objects for a single plant batch
v2_plantbatches_inactive_get GET /v2/plantbatches/inactive List of inactive plantbatches
v2_plantbatches_onhold_get GET /v2/plantbatches/onhold List of on hold plantbatches

v2_plantbatches_active_get

V2PlantbatchesActiveGet200Response v2_plantbatches_active_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)

List of active plant batches

NOTE: States such as CA use Metrc plant tags as names, other states allow unrestricted names for plant batches.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import t3api
from t3api.models.v2_plantbatches_active_get200_response import V2PlantbatchesActiveGet200Response
from t3api.rest import ApiException
from pprint import pprint

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

# 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): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.PlantBatchesApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    page = 1 # int | The index of the page to be returned. (optional) (default to 1)
    page_size = 100 # int | The number of objects per page to be returned. (optional) (default to 100)
    strict_pagination = False # bool | Toggles strict pagination. Defaults to `false` (disabled)    - If enabled, requesting an out of bounds page will throw a 400.    - If disabled, requesting an out of bounds page will return a 200 and an empty page. (optional) (default to False)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)

    try:
        # List of active plant batches
        api_response = api_instance.v2_plantbatches_active_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)
        print("The response of PlantBatchesApi->v2_plantbatches_active_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlantBatchesApi->v2_plantbatches_active_get: %s\n" % e)

Parameters

Name Type Description Notes
license_number str The unique identifier for the license associated with this request.
page int The index of the page to be returned. [optional] [default to 1]
page_size int The number of objects per page to be returned. [optional] [default to 100]
strict_pagination bool Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page. [optional] [default to False]
sort str Defines the collection sort order. [optional]
filter_logic str Describes how the filters, if any, should be applied [optional] [default to and]
filter List[str] One or more collection filters. [optional]

Return type

V2PlantbatchesActiveGet200Response

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of active plantbatches for this license -

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

v2_plantbatches_active_report_get

V2PlantbatchesActiveReportGet200Response v2_plantbatches_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)

Generate a report of all active plant batches

Note: this endpoint supports secret key authentication.

Example

  • Bearer (JWT) Authentication (BearerAuth):
import t3api
from t3api.models.v2_plantbatches_active_report_get200_response import V2PlantbatchesActiveReportGet200Response
from t3api.rest import ApiException
from pprint import pprint

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

# 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): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.PlantBatchesApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    secret_key = '2616ec56-fa2a-4c5b-86c0-acacf23c9ef7' # str | Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated [here](/v2/pages/secret-key).  (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    content_type = json # str | Specifies how the report should be formatted. Can be returned as json or csv. *This can also be defined in the Content-Type header*  (optional) (default to json)
    prepend_csv_metadata = true # str | Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned.  (optional) (default to true)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)
    fieldnames = 'name,locationName,strainName,plantedDate,untrackedCount' # str | Defines which plant fields should appear in the report data. (optional) (default to 'name,locationName,strainName,plantedDate,untrackedCount')

    try:
        # Generate a report of all active plant batches
        api_response = api_instance.v2_plantbatches_active_report_get(license_number, secret_key=secret_key, filter_logic=filter_logic, content_type=content_type, prepend_csv_metadata=prepend_csv_metadata, sort=sort, filter=filter, fieldnames=fieldnames)
        print("The response of PlantBatchesApi->v2_plantbatches_active_report_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlantBatchesApi->v2_plantbatches_active_report_get: %s\n" % e)

Parameters

Name Type Description Notes
license_number str The unique identifier for the license associated with this request.
secret_key str Your secret key, if you wish to authenticate via query params. Secret keys can be manually generated here. [optional]
filter_logic str Describes how the filters, if any, should be applied [optional] [default to and]
content_type str Specifies how the report should be formatted. Can be returned as json or csv. This can also be defined in the Content-Type header [optional] [default to json]
prepend_csv_metadata str Controls if the CSV header metadata should be included in the output. When set to false, only the column headers and data will be returned. [optional] [default to true]
sort str Defines the collection sort order. [optional]
filter List[str] One or more collection filters. [optional]
fieldnames str Defines which plant fields should appear in the report data. [optional] [default to 'name,locationName,strainName,plantedDate,untrackedCount']

Return type

V2PlantbatchesActiveReportGet200Response

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/csv

HTTP response details

Status code Description Response headers
200 A list of active plant batches for this license -

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

v2_plantbatches_history_get

V2ItemsHistoryGet200Response v2_plantbatches_history_get(license_number, plant_batch_id, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)

List of history objects for a single plant batch

NOTE: only supports INACTIVE plant batches

Example

  • Bearer (JWT) Authentication (BearerAuth):
import t3api
from t3api.models.v2_items_history_get200_response import V2ItemsHistoryGet200Response
from t3api.rest import ApiException
from pprint import pprint

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

# 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): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.PlantBatchesApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    plant_batch_id = 123 # float | ID of the target plant batch
    page = 1 # int | The index of the page to be returned. (optional) (default to 1)
    page_size = 100 # int | The number of objects per page to be returned. (optional) (default to 100)
    strict_pagination = False # bool | Toggles strict pagination. Defaults to `false` (disabled)    - If enabled, requesting an out of bounds page will throw a 400.    - If disabled, requesting an out of bounds page will return a 200 and an empty page. (optional) (default to False)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)

    try:
        # List of history objects for a single plant batch
        api_response = api_instance.v2_plantbatches_history_get(license_number, plant_batch_id, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)
        print("The response of PlantBatchesApi->v2_plantbatches_history_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlantBatchesApi->v2_plantbatches_history_get: %s\n" % e)

Parameters

Name Type Description Notes
license_number str The unique identifier for the license associated with this request.
plant_batch_id float ID of the target plant batch
page int The index of the page to be returned. [optional] [default to 1]
page_size int The number of objects per page to be returned. [optional] [default to 100]
strict_pagination bool Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page. [optional] [default to False]
sort str Defines the collection sort order. [optional]
filter_logic str Describes how the filters, if any, should be applied [optional] [default to and]
filter List[str] One or more collection filters. [optional]

Return type

V2ItemsHistoryGet200Response

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of package history objects for the specified plant batch. -
401 The plant batch with id={plantBatchId} was not found in the specified license, or you do not have access to view this plant batch's history -

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

v2_plantbatches_inactive_get

V2PlantbatchesActiveGet200Response v2_plantbatches_inactive_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)

List of inactive plantbatches

Example

  • Bearer (JWT) Authentication (BearerAuth):
import t3api
from t3api.models.v2_plantbatches_active_get200_response import V2PlantbatchesActiveGet200Response
from t3api.rest import ApiException
from pprint import pprint

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

# 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): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.PlantBatchesApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    page = 1 # int | The index of the page to be returned. (optional) (default to 1)
    page_size = 100 # int | The number of objects per page to be returned. (optional) (default to 100)
    strict_pagination = False # bool | Toggles strict pagination. Defaults to `false` (disabled)    - If enabled, requesting an out of bounds page will throw a 400.    - If disabled, requesting an out of bounds page will return a 200 and an empty page. (optional) (default to False)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)

    try:
        # List of inactive plantbatches
        api_response = api_instance.v2_plantbatches_inactive_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)
        print("The response of PlantBatchesApi->v2_plantbatches_inactive_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlantBatchesApi->v2_plantbatches_inactive_get: %s\n" % e)

Parameters

Name Type Description Notes
license_number str The unique identifier for the license associated with this request.
page int The index of the page to be returned. [optional] [default to 1]
page_size int The number of objects per page to be returned. [optional] [default to 100]
strict_pagination bool Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page. [optional] [default to False]
sort str Defines the collection sort order. [optional]
filter_logic str Describes how the filters, if any, should be applied [optional] [default to and]
filter List[str] One or more collection filters. [optional]

Return type

V2PlantbatchesActiveGet200Response

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of inactive plantbatches for this license -

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

v2_plantbatches_onhold_get

V2PlantbatchesActiveGet200Response v2_plantbatches_onhold_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)

List of on hold plantbatches

Example

  • Bearer (JWT) Authentication (BearerAuth):
import t3api
from t3api.models.v2_plantbatches_active_get200_response import V2PlantbatchesActiveGet200Response
from t3api.rest import ApiException
from pprint import pprint

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

# 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): BearerAuth
configuration = t3api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with t3api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = t3api.PlantBatchesApi(api_client)
    license_number = 'LIC-00001' # str | The unique identifier for the license associated with this request.
    page = 1 # int | The index of the page to be returned. (optional) (default to 1)
    page_size = 100 # int | The number of objects per page to be returned. (optional) (default to 100)
    strict_pagination = False # bool | Toggles strict pagination. Defaults to `false` (disabled)    - If enabled, requesting an out of bounds page will throw a 400.    - If disabled, requesting an out of bounds page will return a 200 and an empty page. (optional) (default to False)
    sort = 'label:asc' # str | Defines the collection sort order. (optional)
    filter_logic = and # str | Describes how the filters, if any, should be applied (optional) (default to and)
    filter = ['label__endswith:0003'] # List[str] | One or more collection filters. (optional)

    try:
        # List of on hold plantbatches
        api_response = api_instance.v2_plantbatches_onhold_get(license_number, page=page, page_size=page_size, strict_pagination=strict_pagination, sort=sort, filter_logic=filter_logic, filter=filter)
        print("The response of PlantBatchesApi->v2_plantbatches_onhold_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PlantBatchesApi->v2_plantbatches_onhold_get: %s\n" % e)

Parameters

Name Type Description Notes
license_number str The unique identifier for the license associated with this request.
page int The index of the page to be returned. [optional] [default to 1]
page_size int The number of objects per page to be returned. [optional] [default to 100]
strict_pagination bool Toggles strict pagination. Defaults to `false` (disabled) - If enabled, requesting an out of bounds page will throw a 400. - If disabled, requesting an out of bounds page will return a 200 and an empty page. [optional] [default to False]
sort str Defines the collection sort order. [optional]
filter_logic str Describes how the filters, if any, should be applied [optional] [default to and]
filter List[str] One or more collection filters. [optional]

Return type

V2PlantbatchesActiveGet200Response

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A list of on hold plantbatches for this license -

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