All URIs are relative to https://apse1.api.affinidi.io/ais
Method | HTTP request | Description |
---|---|---|
create_pex_query | POST /v1/configurations/{configurationId}/pex-queries | |
delete_pex_query_by_id | DELETE /v1/configurations/{configurationId}/pex-queries/{queryId} | |
get_pex_query_by_id | GET /v1/configurations/{configurationId}/pex-queries/{queryId} | |
list_pex_queries | GET /v1/configurations/{configurationId}/pex-queries | |
update_pex_query_by_id | PATCH /v1/configurations/{configurationId}/pex-queries/{queryId} |
PexQueryDto create_pex_query(configuration_id, create_pex_query_input)
- Api Key Authentication (ProjectTokenAuth):
import time
import os
import affinidi_tdk_iota_client
from affinidi_tdk_iota_client.models.create_pex_query_input import CreatePexQueryInput
from affinidi_tdk_iota_client.models.pex_query_dto import PexQueryDto
from affinidi_tdk_iota_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ais
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_iota_client.Configuration(
host = "https://apse1.api.affinidi.io/ais"
)
# 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 API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_iota_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client)
configuration_id = 'configuration_id_example' # str | iotaConfiguration Id
create_pex_query_input = affinidi_tdk_iota_client.CreatePexQueryInput() # CreatePexQueryInput | CreatePexQuery
try:
api_response = api_instance.create_pex_query(configuration_id, create_pex_query_input)
print("The response of PexQueryApi->create_pex_query:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PexQueryApi->create_pex_query: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
configuration_id | str | iotaConfiguration Id | |
create_pex_query_input | CreatePexQueryInput | CreatePexQuery |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
201 | CreatePexQueryOK | - |
400 | BadRequestError | - |
403 | ForbiddenError | - |
404 | NotFoundError | - |
409 | ConflictError | - |
422 | UnprocessableEntity | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_pex_query_by_id(configuration_id, query_id)
- Api Key Authentication (ProjectTokenAuth):
import time
import os
import affinidi_tdk_iota_client
from affinidi_tdk_iota_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ais
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_iota_client.Configuration(
host = "https://apse1.api.affinidi.io/ais"
)
# 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 API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_iota_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client)
configuration_id = 'configuration_id_example' # str | iotaConfiguration Id
query_id = 'query_id_example' # str | pex-query Id
try:
api_instance.delete_pex_query_by_id(configuration_id, query_id)
except Exception as e:
print("Exception when calling PexQueryApi->delete_pex_query_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
configuration_id | str | iotaConfiguration Id | |
query_id | str | pex-query Id |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
204 | Deleted | - |
400 | BadRequestError | - |
403 | ForbiddenError | - |
404 | NotFoundError | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PexQueryDto get_pex_query_by_id(configuration_id, query_id)
- Api Key Authentication (ProjectTokenAuth):
import time
import os
import affinidi_tdk_iota_client
from affinidi_tdk_iota_client.models.pex_query_dto import PexQueryDto
from affinidi_tdk_iota_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ais
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_iota_client.Configuration(
host = "https://apse1.api.affinidi.io/ais"
)
# 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 API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_iota_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client)
configuration_id = 'configuration_id_example' # str | iotaConfiguration Id
query_id = 'query_id_example' # str | pex-query Id
try:
api_response = api_instance.get_pex_query_by_id(configuration_id, query_id)
print("The response of PexQueryApi->get_pex_query_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PexQueryApi->get_pex_query_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
configuration_id | str | iotaConfiguration Id | |
query_id | str | pex-query Id |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | GetPexQueryByIdOK | - |
400 | BadRequestError | - |
403 | ForbiddenError | - |
404 | NotFoundError | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListPexQueriesOK list_pex_queries(configuration_id, limit=limit, exclusive_start_key=exclusive_start_key)
- Api Key Authentication (ProjectTokenAuth):
import time
import os
import affinidi_tdk_iota_client
from affinidi_tdk_iota_client.models.list_pex_queries_ok import ListPexQueriesOK
from affinidi_tdk_iota_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ais
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_iota_client.Configuration(
host = "https://apse1.api.affinidi.io/ais"
)
# 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 API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_iota_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client)
configuration_id = 'configuration_id_example' # str | iotaConfiguration Id
limit = 56 # int | Maximum number of records to fetch in a list (optional)
exclusive_start_key = 'exclusive_start_key_example' # str | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. (optional)
try:
api_response = api_instance.list_pex_queries(configuration_id, limit=limit, exclusive_start_key=exclusive_start_key)
print("The response of PexQueryApi->list_pex_queries:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PexQueryApi->list_pex_queries: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
configuration_id | str | iotaConfiguration Id | |
limit | int | Maximum number of records to fetch in a list | [optional] |
exclusive_start_key | str | The base64url encoded key of the first item that this operation will evaluate (it is not returned). Use the value that was returned in the previous operation. | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | ListPexQueriesOK | - |
400 | BadRequestError | - |
403 | ForbiddenError | - |
404 | NotFoundError | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PexQueryDto update_pex_query_by_id(configuration_id, query_id, update_pex_query_input)
- Api Key Authentication (ProjectTokenAuth):
import time
import os
import affinidi_tdk_iota_client
from affinidi_tdk_iota_client.models.pex_query_dto import PexQueryDto
from affinidi_tdk_iota_client.models.update_pex_query_input import UpdatePexQueryInput
from affinidi_tdk_iota_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/ais
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_iota_client.Configuration(
host = "https://apse1.api.affinidi.io/ais"
)
# 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 API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_iota_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_iota_client.PexQueryApi(api_client)
configuration_id = 'configuration_id_example' # str | iotaConfiguration Id
query_id = 'query_id_example' # str | pex-query Id
update_pex_query_input = affinidi_tdk_iota_client.UpdatePexQueryInput() # UpdatePexQueryInput | UpdatePexQueryById
try:
api_response = api_instance.update_pex_query_by_id(configuration_id, query_id, update_pex_query_input)
print("The response of PexQueryApi->update_pex_query_by_id:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PexQueryApi->update_pex_query_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
configuration_id | str | iotaConfiguration Id | |
query_id | str | pex-query Id | |
update_pex_query_input | UpdatePexQueryInput | UpdatePexQueryById |
- Content-Type: application/json
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
200 | UpdatePexQueryByIdOK | - |
400 | BadRequestError | - |
403 | ForbiddenError | - |
404 | NotFoundError | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]