You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

22 KiB

Raw Blame History

cvat_sdk.CommentsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
comments_create	POST /api/comments	Method creates a comment
comments_destroy	DELETE /api/comments/{id}	Method deletes a comment
comments_list	GET /api/comments	Method returns a paginated list of comments according to query parameters
comments_partial_update	PATCH /api/comments/{id}	Methods does a partial update of chosen fields in a comment
comments_retrieve	GET /api/comments/{id}	Method returns details of a comment

comments_create

CommentWrite comments_create(comment_write_request)

Method creates a comment

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 comments_api
from cvat_sdk.model.comment_write import CommentWrite
from cvat_sdk.model.comment_write_request import CommentWriteRequest
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 = comments_api.CommentsApi(api_client)
    comment_write_request = CommentWriteRequest(
        issue=1,
        message="message_example",
    ) # CommentWriteRequest | 
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method creates a comment
        api_response = api_instance.comments_create(comment_write_request)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_create: %s\n" % e)

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

Parameters

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

Return type

CommentWrite

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
201		-

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

comments_destroy

comments_destroy(id)

Method deletes a comment

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 comments_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 = comments_api.CommentsApi(api_client)
    id = 1 # int | A unique integer value identifying this comment.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method deletes a comment
        api_instance.comments_destroy(id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_destroy: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method deletes a comment
        api_instance.comments_destroy(id, x_organization=x_organization, org=org, org_id=org_id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this comment.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	The comment has been deleted	-

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

comments_list

PaginatedCommentReadList comments_list()

Method returns a paginated list of comments according to query parameters

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 comments_api
from cvat_sdk.model.paginated_comment_read_list import PaginatedCommentReadList
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 = comments_api.CommentsApi(api_client)
    x_organization = "X-Organization_example" # str |  (optional)
    filter = "filter_example" # str | A filter term. Avaliable filter_fields: ['owner', 'id', 'issue_id'] (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    search = "search_example" # str | A search term. Avaliable search_fields: ('owner',) (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Avaliable ordering_fields: ['owner', 'id', 'issue_id'] (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns a paginated list of comments according to query parameters
        api_response = api_instance.comments_list(x_organization=x_organization, filter=filter, org=org, org_id=org_id, page=page, page_size=page_size, search=search, sort=sort)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_organization	str		[optional]
filter	str	A filter term. Avaliable filter_fields: ['owner', 'id', 'issue_id']	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term. Avaliable search_fields: ('owner',)	[optional]
sort	str	Which field to use when ordering the results. Avaliable ordering_fields: ['owner', 'id', 'issue_id']	[optional]

Return type

PaginatedCommentReadList

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
200		-

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

comments_partial_update

CommentWrite comments_partial_update(id)

Methods does a partial update of chosen fields in a comment

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 comments_api
from cvat_sdk.model.comment_write import CommentWrite
from cvat_sdk.model.patched_comment_write_request import PatchedCommentWriteRequest
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 = comments_api.CommentsApi(api_client)
    id = 1 # int | A unique integer value identifying this comment.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    patched_comment_write_request = PatchedCommentWriteRequest(
        issue=1,
        message="message_example",
    ) # PatchedCommentWriteRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Methods does a partial update of chosen fields in a comment
        api_response = api_instance.comments_partial_update(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_partial_update: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Methods does a partial update of chosen fields in a comment
        api_response = api_instance.comments_partial_update(id, x_organization=x_organization, org=org, org_id=org_id, patched_comment_write_request=patched_comment_write_request)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this comment.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
patched_comment_write_request	PatchedCommentWriteRequest		[optional]

Return type

CommentWrite

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
200		-

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

comments_retrieve

CommentRead comments_retrieve(id)

Method returns details of a comment

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 comments_api
from cvat_sdk.model.comment_read import CommentRead
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 = comments_api.CommentsApi(api_client)
    id = 1 # int | A unique integer value identifying this comment.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method returns details of a comment
        api_response = api_instance.comments_retrieve(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_retrieve: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns details of a comment
        api_response = api_instance.comments_retrieve(id, x_organization=x_organization, org=org, org_id=org_id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling CommentsApi->comments_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this comment.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

CommentRead

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
200		-

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

22 KiB Raw Blame History

cvat_sdk.CommentsApi

comments_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

comments_destroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

comments_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

comments_partial_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

comments_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

22 KiB

Raw Blame History