avis_client.QualityCriteriaApi
All URIs are relative to http://localhost:8000
Method | HTTP request | Description |
---|---|---|
quality_criteria_create | POST /api/quality-criteria/ | |
quality_criteria_destroy | DELETE /api/quality-criteria/{id}/ | |
quality_criteria_list | GET /api/quality-criteria/ | |
quality_criteria_partial_update | PATCH /api/quality-criteria/{id}/ | |
quality_criteria_retrieve | GET /api/quality-criteria/{id}/ | |
quality_criteria_update | PUT /api/quality-criteria/{id}/ |
quality_criteria_create
QualityCriteria quality_criteria_create(quality_criteria_request)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.models.quality_criteria import QualityCriteria
from avis_client.models.quality_criteria_request import QualityCriteriaRequest
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
quality_criteria_request = avis_client.QualityCriteriaRequest() # QualityCriteriaRequest |
try:
api_response = api_instance.quality_criteria_create(quality_criteria_request)
print("The response of QualityCriteriaApi->quality_criteria_create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_create: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
quality_criteria_request | QualityCriteriaRequest |
Return type
Authorization
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 |
---|---|---|
201 | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
quality_criteria_destroy
quality_criteria_destroy(id)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
id = 56 # int | A unique integer value identifying this quality criteria.
try:
api_instance.quality_criteria_destroy(id)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_destroy: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this quality criteria. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
204 | No response body | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
quality_criteria_list
PaginatedQualityCriteriaList quality_criteria_list(fields=fields, id=id, ordering=ordering, page=page, page_size=page_size)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.models.paginated_quality_criteria_list import PaginatedQualityCriteriaList
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
fields = 'fields_example' # str | (optional)
id = [56] # List[int] | Multiple values may be separated by commas. (optional)
ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
page = 56 # int | A page number within the paginated result set. (optional)
page_size = 56 # int | Number of results to return per page. (optional)
try:
api_response = api_instance.quality_criteria_list(fields=fields, id=id, ordering=ordering, page=page, page_size=page_size)
print("The response of QualityCriteriaApi->quality_criteria_list:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_list: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
fields | str | [optional] | |
id | List[int] | Multiple values may be separated by commas. | [optional] |
ordering | str | Which field to use when ordering the results. | [optional] |
page | int | A page number within the paginated result set. | [optional] |
page_size | int | Number of results to return per page. | [optional] |
Return type
Authorization
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]
quality_criteria_partial_update
QualityCriteria quality_criteria_partial_update(id, patched_quality_criteria_request=patched_quality_criteria_request)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.models.patched_quality_criteria_request import PatchedQualityCriteriaRequest
from avis_client.models.quality_criteria import QualityCriteria
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
id = 56 # int | A unique integer value identifying this quality criteria.
patched_quality_criteria_request = avis_client.PatchedQualityCriteriaRequest() # PatchedQualityCriteriaRequest | (optional)
try:
api_response = api_instance.quality_criteria_partial_update(id, patched_quality_criteria_request=patched_quality_criteria_request)
print("The response of QualityCriteriaApi->quality_criteria_partial_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_partial_update: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this quality criteria. | |
patched_quality_criteria_request | PatchedQualityCriteriaRequest | [optional] |
Return type
Authorization
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]
quality_criteria_retrieve
QualityCriteria quality_criteria_retrieve(id, fields=fields)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.models.quality_criteria import QualityCriteria
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
id = 56 # int | A unique integer value identifying this quality criteria.
fields = 'fields_example' # str | (optional)
try:
api_response = api_instance.quality_criteria_retrieve(id, fields=fields)
print("The response of QualityCriteriaApi->quality_criteria_retrieve:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_retrieve: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this quality criteria. | |
fields | str | [optional] |
Return type
Authorization
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]
quality_criteria_update
QualityCriteria quality_criteria_update(id, quality_criteria_request)
A base viewset that allows reading, creating and updating objects. The following functionalities are added by the mixins: * CreateModelMixin: allows creating objects * UpdateModelMixin: allows updating objects * DestroyModelMixin: allows deleting objects * OptimizedReadOnlyTracedViewSet: allows reading objects and adds tracing and optimized queryset fetching (with the use of the fields
query parameter)
Example
- Api Key Authentication (cookieAuth):
- Api Key Authentication (ApiKeyAuth):
import time
import os
import avis_client
from avis_client.models.quality_criteria import QualityCriteria
from avis_client.models.quality_criteria_request import QualityCriteriaRequest
from avis_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = avis_client.Configuration(
host = "http://localhost:8000"
)
# 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: 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'
# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with avis_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = avis_client.QualityCriteriaApi(api_client)
id = 56 # int | A unique integer value identifying this quality criteria.
quality_criteria_request = avis_client.QualityCriteriaRequest() # QualityCriteriaRequest |
try:
api_response = api_instance.quality_criteria_update(id, quality_criteria_request)
print("The response of QualityCriteriaApi->quality_criteria_update:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QualityCriteriaApi->quality_criteria_update: %s\n" % e)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | int | A unique integer value identifying this quality criteria. | |
quality_criteria_request | QualityCriteriaRequest |
Return type
Authorization
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]