Skip to content

Latest commit

 

History

History
279 lines (207 loc) · 8.84 KB

TagApi.md

File metadata and controls

279 lines (207 loc) · 8.84 KB
Raw

sysml_v2_api_client.TagApi

All URIs are relative to http://localhost

Method HTTP request Description
delete_tag_by_project_and_id DELETE /projects/{projectId}/tags/{tagId} Delete tag by project and ID
get_tag_by_project_and_id GET /projects/{projectId}/tags/{tagId} Get tag by project and ID
get_tags_by_project GET /projects/{projectId}/tags Get tags by project
post_tag_by_project POST /projects/{projectId}/tags Create tag by project

delete_tag_by_project_and_id

Tag delete_tag_by_project_and_id(project_id, tag_id)

Delete tag by project and ID

Example

from __future__ import print_function
import time
import sysml_v2_api_client
from sysml_v2_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 = sysml_v2_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with sysml_v2_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = sysml_v2_api_client.TagApi(api_client)
    project_id = 'project_id_example' # str | ID of the project
tag_id = 'tag_id_example' # str | ID of the tag

    try:
        # Delete tag by project and ID
        api_response = api_instance.delete_tag_by_project_and_id(project_id, tag_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TagApi->delete_tag_by_project_and_id: %s\n" % e)

Parameters

Name Type Description Notes
project_id str ID of the project
tag_id str ID of the tag

Return type

Tag

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/ld+json

HTTP response details

Status code Description Response headers
200 Ok -
404 Not found. -
415 The requested content type is not acceptable. -
500 Internal server error. -
0 Unexpected response. -

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

get_tag_by_project_and_id

Tag get_tag_by_project_and_id(project_id, tag_id)

Get tag by project and ID

Example

from __future__ import print_function
import time
import sysml_v2_api_client
from sysml_v2_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 = sysml_v2_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with sysml_v2_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = sysml_v2_api_client.TagApi(api_client)
    project_id = 'project_id_example' # str | ID of the project
tag_id = 'tag_id_example' # str | ID of the tag

    try:
        # Get tag by project and ID
        api_response = api_instance.get_tag_by_project_and_id(project_id, tag_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TagApi->get_tag_by_project_and_id: %s\n" % e)

Parameters

Name Type Description Notes
project_id str ID of the project
tag_id str ID of the tag

Return type

Tag

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/ld+json

HTTP response details

Status code Description Response headers
200 Ok -
404 Not found. -
415 The requested content type is not acceptable. -
500 Internal server error. -
0 Unexpected response. -

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

get_tags_by_project

list[Tag] get_tags_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)

Get tags by project

Example

from __future__ import print_function
import time
import sysml_v2_api_client
from sysml_v2_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 = sysml_v2_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with sysml_v2_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = sysml_v2_api_client.TagApi(api_client)
    project_id = 'project_id_example' # str | ID of the project
page_after = 'page_after_example' # str | Page after (optional)
page_before = 'page_before_example' # str | Page before (optional)
page_size = 56 # int | Page size (optional)

    try:
        # Get tags by project
        api_response = api_instance.get_tags_by_project(project_id, page_after=page_after, page_before=page_before, page_size=page_size)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TagApi->get_tags_by_project: %s\n" % e)

Parameters

Name Type Description Notes
project_id str ID of the project
page_after str Page after [optional]
page_before str Page before [optional]
page_size int Page size [optional]

Return type

list[Tag]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/ld+json

HTTP response details

Status code Description Response headers
200 Ok -
404 Not found. -
415 The requested content type is not acceptable. -
500 Internal server error. -
0 Unexpected response. -

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

post_tag_by_project

Branch post_tag_by_project(project_id, body)

Create tag by project

Example

from __future__ import print_function
import time
import sysml_v2_api_client
from sysml_v2_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 = sysml_v2_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with sysml_v2_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = sysml_v2_api_client.TagApi(api_client)
    project_id = 'project_id_example' # str | ID of the project
body = sysml_v2_api_client.Tag() # Tag | 

    try:
        # Create tag by project
        api_response = api_instance.post_tag_by_project(project_id, body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling TagApi->post_tag_by_project: %s\n" % e)

Parameters

Name Type Description Notes
project_id str ID of the project
body Tag

Return type

Branch

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, application/ld+json

HTTP response details

Status code Description Response headers
201 Created -
415 The requested content type is not acceptable. -
500 Internal server error. -
0 Unexpected response. -

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