Skip to content

TopicApi.md

Latest commit

 

History

History
234 lines (158 loc) · 7.66 KB

TopicApi.md

File metadata and controls

234 lines (158 loc) · 7.66 KB
Raw

multiflexi_client.TopicApi

All URIs are relative to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0

Method HTTP request Description
get_all_topics GET /topics.{suffix} Get All Topics
get_topic GET /topic/{topicId}.{suffix} Get Topic by ID
update_topic POST /topic/{topicId}.{suffix} Update Topic

get_all_topics

List[Topic] get_all_topics(suffix, limit=limit, offset=offset, order=order)

Get All Topics

Retrieve all topics

Example

import multiflexi_client
from multiflexi_client.models.topic import Topic
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.TopicApi(api_client)
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)
    offset = 0 # int | number of records to skip (for pagination) (optional) (default to 0)
    order = '-id' # str | field name to order results by (use '-' prefix for descending, e.g. '-id') (optional)

    try:
        # Get All Topics
        api_response = api_instance.get_all_topics(suffix, limit=limit, offset=offset, order=order)
        print("The response of TopicApi->get_all_topics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TopicApi->get_all_topics: %s\n" % e)

Parameters

Name Type Description Notes
suffix str force format suffix [default to html]
limit int maximum number of results to return [optional] [default to 20]
offset int number of records to skip (for pagination) [optional] [default to 0]
order str field name to order results by (use '-' prefix for descending, e.g. '-id') [optional]

Return type

List[Topic]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 successful operation -
401 Authentication information is missing or invalid * WWW_Authenticate -

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

get_topic

GetTopic200Response get_topic(topic_id, suffix, limit=limit)

Get Topic by ID

Retrieve topic by ID

Example

import multiflexi_client
from multiflexi_client.models.get_topic200_response import GetTopic200Response
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.TopicApi(api_client)
    topic_id = 56 # int | ID of Topic to return
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Get Topic by ID
        api_response = api_instance.get_topic(topic_id, suffix, limit=limit)
        print("The response of TopicApi->get_topic:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TopicApi->get_topic: %s\n" % e)

Parameters

Name Type Description Notes
topic_id int ID of Topic to return
suffix str force format suffix [default to html]
limit int maximum number of results to return [optional] [default to 20]

Return type

GetTopic200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful operation -
400 Invalid ID supplied -
401 Authentication information is missing or invalid * WWW_Authenticate -

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

update_topic

GetTopic200Response update_topic(topic_id, suffix, limit=limit)

Update Topic

Update topic

Example

import multiflexi_client
from multiflexi_client.models.get_topic200_response import GetTopic200Response
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.TopicApi(api_client)
    topic_id = 56 # int | ID of Topic to return
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Update Topic
        api_response = api_instance.update_topic(topic_id, suffix, limit=limit)
        print("The response of TopicApi->update_topic:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TopicApi->update_topic: %s\n" % e)

Parameters

Name Type Description Notes
topic_id int ID of Topic to return
suffix str force format suffix [default to html]
limit int maximum number of results to return [optional] [default to 20]

Return type

GetTopic200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Record was updated -
400 Invalid ID supplied -
401 Authentication information is missing or invalid * WWW_Authenticate -

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