ObjectApi.md

ecotaxa_py_client.ObjectApi

All URIs are relative to https://ecotaxa.obs-vlfr.fr/api

Method	HTTP request	Description
object_query	GET /object/{object_id}	Object Query
object_query_history	GET /object/{object_id}/history	Object Query History

object_query

ObjectModel object_query(object_id)

Object Query

Returns information about the object corresponding to the given id. 🔒 Anonymous reader can do if the project has the right rights :)

Example

• OAuth Authentication (BearerOrCookieAuth):

import ecotaxa_py_client
from ecotaxa_py_client.models.object_model import ObjectModel
from ecotaxa_py_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://ecotaxa.obs-vlfr.fr/api
# See configuration.py for a list of all supported configuration parameters.
configuration = ecotaxa_py_client.Configuration(
    host = "https://ecotaxa.obs-vlfr.fr/api"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with ecotaxa_py_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ecotaxa_py_client.ObjectApi(api_client)
    object_id = 1 # int | Internal, the unique numeric id of this object.

    try:
        # Object Query
        api_response = api_instance.object_query(object_id)
        print("The response of ObjectApi->object_query:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectApi->object_query: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_id	int	Internal, the unique numeric id of this object.

Return type

ObjectModel

Authorization

BearerOrCookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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

object_query_history

List[HistoricalClassification] object_query_history(object_id)

Object Query History

Returns information about the object's history corresponding to the given id.

Example

• OAuth Authentication (BearerOrCookieAuth):

import ecotaxa_py_client
from ecotaxa_py_client.models.historical_classification import HistoricalClassification
from ecotaxa_py_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://ecotaxa.obs-vlfr.fr/api
# See configuration.py for a list of all supported configuration parameters.
configuration = ecotaxa_py_client.Configuration(
    host = "https://ecotaxa.obs-vlfr.fr/api"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with ecotaxa_py_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ecotaxa_py_client.ObjectApi(api_client)
    object_id = 1 # int | Internal, the unique numeric id of this object.

    try:
        # Object Query History
        api_response = api_instance.object_query_history(object_id)
        print("The response of ObjectApi->object_query_history:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectApi->object_query_history: %s\n" % e)

Parameters

Name	Type	Description	Notes
object_id	int	Internal, the unique numeric id of this object.

Return type

List[HistoricalClassification]

Authorization

BearerOrCookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

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