avis_client.ImageApi

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

Method	HTTP request	Description
image_create	POST /api/image/
image_destroy	DELETE /api/image/{id}/
image_list	GET /api/image/
image_partial_update	PATCH /api/image/{id}/
image_quality_list	GET /api/image/quality/
image_retrieve	GET /api/image/{id}/
image_update	PUT /api/image/{id}/

image_create

Image image_create(team, capture_datetime, file, inspection=inspection, uploaded_by=uploaded_by, results=results, format=format, part_id=part_id, validation_status=validation_status)

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.format_enum import FormatEnum
from avis_client.models.image import Image
from avis_client.models.validation_status_enum import ValidationStatusEnum
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.ImageApi(api_client)
    team = 56 # int |
    capture_datetime = '2013-10-20T19:20:30+01:00' # datetime |
    file = None # bytearray |
    inspection = 56 # int |  (optional)
    uploaded_by = 56 # int |  (optional)
    results = [56] # List[int] |  (optional)
    format = avis_client.FormatEnum() # FormatEnum |  (optional)
    part_id = 'part_id_example' # str |  (optional)
    validation_status = avis_client.ValidationStatusEnum() # ValidationStatusEnum |  (optional)

    try:
        api_response = api_instance.image_create(team, capture_datetime, file, inspection=inspection, uploaded_by=uploaded_by, results=results, format=format, part_id=part_id, validation_status=validation_status)
        print("The response of ImageApi->image_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageApi->image_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
team	int
capture_datetime	datetime
file	bytearray
inspection	int		[optional]
uploaded_by	int		[optional]
results	List[int]		[optional]
format	FormatEnum		[optional]
part_id	str		[optional]
validation_status	ValidationStatusEnum		[optional]

Return type

Image

Authorization

cookieAuth, ApiKeyAuth

HTTP request headers

• Content-Type: 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]

image_destroy

image_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.ImageApi(api_client)
    id = 56 # int | A unique integer value identifying this image.

    try:
        api_instance.image_destroy(id)
    except Exception as e:
        print("Exception when calling ImageApi->image_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this image.

Return type

void (empty response body)

Authorization

cookieAuth, ApiKeyAuth

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]

image_list

PaginatedImageList image_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_image_list import PaginatedImageList
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.ImageApi(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.image_list(fields=fields, id=id, ordering=ordering, page=page, page_size=page_size)
        print("The response of ImageApi->image_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageApi->image_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

PaginatedImageList

Authorization

cookieAuth, ApiKeyAuth

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]

image_partial_update

Image image_partial_update(id, patched_image_request=patched_image_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.image import Image
from avis_client.models.patched_image_request import PatchedImageRequest
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.ImageApi(api_client)
    id = 56 # int | A unique integer value identifying this image.
    patched_image_request = avis_client.PatchedImageRequest() # PatchedImageRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this image.
patched_image_request	PatchedImageRequest		[optional]

Return type

Image

Authorization

cookieAuth, ApiKeyAuth

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]

image_quality_list

PaginatedQualityCriteriaResultList image_quality_list(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_result_list import PaginatedQualityCriteriaResultList
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.ImageApi(api_client)
    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.image_quality_list(id=id, ordering=ordering, page=page, page_size=page_size)
        print("The response of ImageApi->image_quality_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ImageApi->image_quality_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
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

PaginatedQualityCriteriaResultList

Authorization

cookieAuth, ApiKeyAuth

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]

image_retrieve

Image image_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.image import Image
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.ImageApi(api_client)
    id = 56 # int | A unique integer value identifying this image.
    fields = 'fields_example' # str |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this image.
fields	str		[optional]

Return type

Image

Authorization

cookieAuth, ApiKeyAuth

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]

image_update

Image image_update(id, image_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.image import Image
from avis_client.models.image_request import ImageRequest
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.ImageApi(api_client)
    id = 56 # int | A unique integer value identifying this image.
    image_request = avis_client.ImageRequest() # ImageRequest |

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this image.
image_request	ImageRequest

Return type

Image

Authorization

cookieAuth, ApiKeyAuth

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]