testit_api_client.WorkItemsCommentsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
api_v2_work_items_comments_comment_id_delete	DELETE /api/v2/workItems/comments/{commentId}	Delete WorkItem comment
api_v2_work_items_comments_post	POST /api/v2/workItems/comments	Create WorkItem comment
api_v2_work_items_comments_put	PUT /api/v2/workItems/comments	Update work item comment
api_v2_work_items_id_comments_count_get	GET /api/v2/workItems/{id}/comments/count	Get work item comments count
api_v2_work_items_id_comments_get	GET /api/v2/workItems/{id}/comments	Get work item comments

api_v2_work_items_comments_comment_id_delete

api_v2_work_items_comments_comment_id_delete(comment_id)

Delete WorkItem comment

Use case User sets comment identifier User runs method execution System delete comment System returns success status code

Example

Api Key Authentication (Bearer or PrivateToken):

import testit_api_client
from testit_api_client.rest import ApiException
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 = testit_api_client.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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with testit_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testit_api_client.WorkItemsCommentsApi(api_client)
    comment_id = '3fa85f64-5717-4562-b3fc-2c963f66afa6' # str | Comment internal (guid format) identifier

    try:
        # Delete WorkItem comment
        api_instance.api_v2_work_items_comments_comment_id_delete(comment_id)
    except Exception as e:
        print("Exception when calling WorkItemsCommentsApi->api_v2_work_items_comments_comment_id_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
comment_id	str	Comment internal (guid format) identifier

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	System admin permission required	-
404	WorkItem is not found	-
409	Conflict	-
422	Unprocessable Entity	-

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

api_v2_work_items_comments_post

WorkItemCommentModel api_v2_work_items_comments_post(work_item_comment_post_model=work_item_comment_post_model)

Create WorkItem comment

Use case User sets comment properties (listed in request parameters) User runs method execution System creates comment System returns comment model (listed in response parameters)

Example

Api Key Authentication (Bearer or PrivateToken):

import testit_api_client
from testit_api_client.models.work_item_comment_model import WorkItemCommentModel
from testit_api_client.models.work_item_comment_post_model import WorkItemCommentPostModel
from testit_api_client.rest import ApiException
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 = testit_api_client.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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with testit_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testit_api_client.WorkItemsCommentsApi(api_client)
    work_item_comment_post_model = testit_api_client.WorkItemCommentPostModel() # WorkItemCommentPostModel |  (optional)

    try:
        # Create WorkItem comment
        api_response = api_instance.api_v2_work_items_comments_post(work_item_comment_post_model=work_item_comment_post_model)
        print("The response of WorkItemsCommentsApi->api_v2_work_items_comments_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkItemsCommentsApi->api_v2_work_items_comments_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
work_item_comment_post_model	WorkItemCommentPostModel		[optional]

Return type

WorkItemCommentModel

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Successful operation	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test library required	-
404	WorkItem is not found	-
409	Conflict	-
422	Unprocessable Entity	-

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

api_v2_work_items_comments_put

api_v2_work_items_comments_put(work_item_comment_put_model=work_item_comment_put_model)

Update work item comment

Example

Api Key Authentication (Bearer or PrivateToken):

import testit_api_client
from testit_api_client.models.work_item_comment_put_model import WorkItemCommentPutModel
from testit_api_client.rest import ApiException
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 = testit_api_client.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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with testit_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testit_api_client.WorkItemsCommentsApi(api_client)
    work_item_comment_put_model = testit_api_client.WorkItemCommentPutModel() # WorkItemCommentPutModel |  (optional)

    try:
        # Update work item comment
        api_instance.api_v2_work_items_comments_put(work_item_comment_put_model=work_item_comment_put_model)
    except Exception as e:
        print("Exception when calling WorkItemsCommentsApi->api_v2_work_items_comments_put: %s\n" % e)

Parameters

Name	Type	Description	Notes
work_item_comment_put_model	WorkItemCommentPutModel		[optional]

Return type

void (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
401	Unauthorized	-
403	System administrator role is required	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

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

api_v2_work_items_id_comments_count_get

int api_v2_work_items_id_comments_count_get(id)

Get work item comments count

Example

Api Key Authentication (Bearer or PrivateToken):

import testit_api_client
from testit_api_client.rest import ApiException
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 = testit_api_client.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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with testit_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testit_api_client.WorkItemsCommentsApi(api_client)
    id = 'id_example' # str | Unique or global ID of the work item

    try:
        # Get work item comments count
        api_response = api_instance.api_v2_work_items_id_comments_count_get(id)
        print("The response of WorkItemsCommentsApi->api_v2_work_items_id_comments_count_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkItemsCommentsApi->api_v2_work_items_id_comments_count_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Unique or global ID of the work item

Return type

int

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test library is required	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

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

api_v2_work_items_id_comments_get

List[WorkItemCommentModel] api_v2_work_items_id_comments_get(id)

Get work item comments

Example

Api Key Authentication (Bearer or PrivateToken):

import testit_api_client
from testit_api_client.models.work_item_comment_model import WorkItemCommentModel
from testit_api_client.rest import ApiException
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 = testit_api_client.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: Bearer or PrivateToken
configuration.api_key['Bearer or PrivateToken'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with testit_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = testit_api_client.WorkItemsCommentsApi(api_client)
    id = 'id_example' # str | Unique or global ID of the work item

    try:
        # Get work item comments
        api_response = api_instance.api_v2_work_items_id_comments_get(id)
        print("The response of WorkItemsCommentsApi->api_v2_work_items_id_comments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WorkItemsCommentsApi->api_v2_work_items_id_comments_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	Unique or global ID of the work item

Return type

List[WorkItemCommentModel]

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Read permission for test library is required	-
404	Not Found	-
409	Conflict	-
422	Unprocessable Entity	-

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

Files

WorkItemsCommentsApi.md

Latest commit

History

WorkItemsCommentsApi.md

File metadata and controls

testit_api_client.WorkItemsCommentsApi

api_v2_work_items_comments_comment_id_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_work_items_comments_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_work_items_comments_put

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_work_items_id_comments_count_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

api_v2_work_items_id_comments_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details