Skip to content

Latest commit

 

History

History
289 lines (189 loc) · 8.63 KB

StorageApi.md

File metadata and controls

289 lines (189 loc) · 8.63 KB
Raw

monday_code.StorageApi

All URIs are relative to http://localhost:59999

Method HTTP request Description
delete_by_key_from_storage DELETE /storage/{key}
get_by_key_from_storage GET /storage/{key}
increment_counter PUT /storage/counter/increment
upsert_by_key_from_storage PUT /storage/{key}

delete_by_key_from_storage

delete_by_key_from_storage(key, x_monday_access_token)

Example

import monday_code
from monday_code.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with monday_code.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = monday_code.StorageApi(api_client)
    key = 'key_example' # str | 
    x_monday_access_token = 'x_monday_access_token_example' # str | 

    try:
        api_instance.delete_by_key_from_storage(key, x_monday_access_token)
    except Exception as e:
        print("Exception when calling StorageApi->delete_by_key_from_storage: %s\n" % e)

Parameters

Name Type Description Notes
key str
x_monday_access_token str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

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

get_by_key_from_storage

StorageDataContract get_by_key_from_storage(key, shared, x_monday_access_token)

Example

import monday_code
from monday_code.models.storage_data_contract import StorageDataContract
from monday_code.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with monday_code.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = monday_code.StorageApi(api_client)
    key = 'key_example' # str | 
    shared = True # bool | 
    x_monday_access_token = 'x_monday_access_token_example' # str | 

    try:
        api_response = api_instance.get_by_key_from_storage(key, shared, x_monday_access_token)
        print("The response of StorageApi->get_by_key_from_storage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageApi->get_by_key_from_storage: %s\n" % e)

Parameters

Name Type Description Notes
key str
shared bool
x_monday_access_token str

Return type

StorageDataContract

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
404 -
500 -

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

increment_counter

IncrementCounter200Response increment_counter(x_monday_access_token, increment_counter_params)

Example

import monday_code
from monday_code.models.increment_counter200_response import IncrementCounter200Response
from monday_code.models.increment_counter_params import IncrementCounterParams
from monday_code.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with monday_code.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = monday_code.StorageApi(api_client)
    x_monday_access_token = 'x_monday_access_token_example' # str | 
    increment_counter_params = monday_code.IncrementCounterParams() # IncrementCounterParams | 

    try:
        api_response = api_instance.increment_counter(x_monday_access_token, increment_counter_params)
        print("The response of StorageApi->increment_counter:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageApi->increment_counter: %s\n" % e)

Parameters

Name Type Description Notes
x_monday_access_token str
increment_counter_params IncrementCounterParams

Return type

IncrementCounter200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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

upsert_by_key_from_storage

UpsertByKeyFromStorage200Response upsert_by_key_from_storage(key, x_monday_access_token, json_data_contract, shared=shared, previous_version=previous_version)

Example

import monday_code
from monday_code.models.json_data_contract import JsonDataContract
from monday_code.models.upsert_by_key_from_storage200_response import UpsertByKeyFromStorage200Response
from monday_code.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with monday_code.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = monday_code.StorageApi(api_client)
    key = 'key_example' # str | 
    x_monday_access_token = 'x_monday_access_token_example' # str | 
    json_data_contract = monday_code.JsonDataContract() # JsonDataContract | 
    shared = True # bool |  (optional)
    previous_version = 'previous_version_example' # str |  (optional)

    try:
        api_response = api_instance.upsert_by_key_from_storage(key, x_monday_access_token, json_data_contract, shared=shared, previous_version=previous_version)
        print("The response of StorageApi->upsert_by_key_from_storage:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling StorageApi->upsert_by_key_from_storage: %s\n" % e)

Parameters

Name Type Description Notes
key str
x_monday_access_token str
json_data_contract JsonDataContract
shared bool [optional]
previous_version str [optional]

Return type

UpsertByKeyFromStorage200Response

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

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