cvat/cvat-sdk/docs/SchemaApi.md

cvat_sdk.SchemaApi

All URIs are relative to http://localhost

Method	HTTP request	Description
schema_retrieve	GET /api/schema/

schema_retrieve

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} schema_retrieve()

OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json

Example

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

import time
import cvat_sdk
from cvat_sdk.api import schema_api
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 = cvat_sdk.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 API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

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

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_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: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

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

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = schema_api.SchemaApi(api_client)
    x_organization = "X-Organization_example" # str |  (optional)
    lang = "af" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    scheme = "json" # str |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.schema_retrieve(x_organization=x_organization, lang=lang, org=org, org_id=org_id, scheme=scheme)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling SchemaApi->schema_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_organization	str		[optional]
lang	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
scheme	str		[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, 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]