NoteApi.md

aiochris_oag.NoteApi

All URIs are relative to http://localhost

Method	HTTP request	Description
note_retrieve	GET /api/v1/note{id}/
note_update	PUT /api/v1/note{id}/

note_retrieve

Note note_retrieve(id)

A note view.

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (tokenAuth):
• Api Key Authentication (cookieAuth):

import aiochris_oag
from aiochris_oag.models.note import Note
from aiochris_oag.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basicAuth
configuration = aiochris_oag.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

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

    try:
        api_response = await api_instance.note_retrieve(id)
        print("The response of NoteApi->note_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NoteApi->note_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

Note

Authorization

basicAuth, tokenAuth, cookieAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

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

note_update

Note note_update(id, note_request=note_request)

A note view.

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (tokenAuth):
• Api Key Authentication (cookieAuth):

import aiochris_oag
from aiochris_oag.models.note import Note
from aiochris_oag.models.note_request import NoteRequest
from aiochris_oag.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: basicAuth
configuration = aiochris_oag.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Enter a context with an instance of the API client
async with aiochris_oag.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aiochris_oag.NoteApi(api_client)
    id = 56 # int | 
    note_request = aiochris_oag.NoteRequest() # NoteRequest |  (optional)

    try:
        api_response = await api_instance.note_update(id, note_request=note_request)
        print("The response of NoteApi->note_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NoteApi->note_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
note_request	NoteRequest		[optional]

Return type

Note

Authorization

basicAuth, tokenAuth, cookieAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

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