Skip to content

Latest commit

 

History

History
403 lines (278 loc) · 12.5 KB

WidgetConfigApi.md

File metadata and controls

403 lines (278 loc) · 12.5 KB

ibutsu_client.WidgetConfigApi

All URIs are relative to /api

Method HTTP request Description
add_widget_config POST /widget-config Create a widget configuration
delete_widget_config DELETE /widget-config/{id} Delete a widget configuration
get_widget_config GET /widget-config/{id} Get a single widget configuration
get_widget_config_list GET /widget-config Get the list of widget configurations
update_widget_config PUT /widget-config/{id} Updates a single widget configuration

add_widget_config

WidgetConfig add_widget_config(widget_config=widget_config)

Create a widget configuration

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.widget_config import WidgetConfig
from ibutsu_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.WidgetConfigApi(api_client)
    widget_config = ibutsu_client.WidgetConfig() # WidgetConfig | Widget configuration (optional)

    try:
        # Create a widget configuration
        api_response = api_instance.add_widget_config(widget_config=widget_config)
        print("The response of WidgetConfigApi->add_widget_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WidgetConfigApi->add_widget_config: %s\n" % e)

Parameters

Name Type Description Notes
widget_config WidgetConfig Widget configuration [optional]

Return type

WidgetConfig

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
400 Bad request, JSON required or not enough parameters -

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

delete_widget_config

delete_widget_config(id)

Delete a widget configuration

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.WidgetConfigApi(api_client)
    id = 'id_example' # str | ID of widget configuration to delete

    try:
        # Delete a widget configuration
        api_instance.delete_widget_config(id)
    except Exception as e:
        print("Exception when calling WidgetConfigApi->delete_widget_config: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of widget configuration to delete

Return type

void (empty response body)

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 The widget configuration was deleted -
404 The widget configuration was not found -

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

get_widget_config

WidgetConfig get_widget_config(id)

Get a single widget configuration

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.widget_config import WidgetConfig
from ibutsu_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.WidgetConfigApi(api_client)
    id = 'id_example' # str | ID of widget config to return

    try:
        # Get a single widget configuration
        api_response = api_instance.get_widget_config(id)
        print("The response of WidgetConfigApi->get_widget_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WidgetConfigApi->get_widget_config: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of widget config to return

Return type

WidgetConfig

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 WidgetConfig item -
404 WidgetConfig not found -

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

get_widget_config_list

WidgetConfigList get_widget_config_list(filter=filter, page=page, page_size=page_size)

Get the list of widget configurations

A list of widget configurations

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.widget_config_list import WidgetConfigList
from ibutsu_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.WidgetConfigApi(api_client)
    filter = ['filter_example'] # List[str] | Fields to filter by (optional)
    page = 56 # int | Set the page of items to return, defaults to 1 (optional)
    page_size = 56 # int | Set the number of items per page, defaults to 25 (optional)

    try:
        # Get the list of widget configurations
        api_response = api_instance.get_widget_config_list(filter=filter, page=page, page_size=page_size)
        print("The response of WidgetConfigApi->get_widget_config_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WidgetConfigApi->get_widget_config_list: %s\n" % e)

Parameters

Name Type Description Notes
filter List[str] Fields to filter by [optional]
page int Set the page of items to return, defaults to 1 [optional]
page_size int Set the number of items per page, defaults to 25 [optional]

Return type

WidgetConfigList

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -

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

update_widget_config

WidgetConfig update_widget_config(id, widget_config=widget_config)

Updates a single widget configuration

Example

  • Bearer (JWT) Authentication (jwt):
import ibutsu_client
from ibutsu_client.models.widget_config import WidgetConfig
from ibutsu_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api
# See configuration.py for a list of all supported configuration parameters.
configuration = ibutsu_client.Configuration(
    host = "/api"
)

# 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 Bearer authorization (JWT): jwt
configuration = ibutsu_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ibutsu_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ibutsu_client.WidgetConfigApi(api_client)
    id = 'id_example' # str | ID of widget configuration to update
    widget_config = ibutsu_client.WidgetConfig() # WidgetConfig | Widget configuration (optional)

    try:
        # Updates a single widget configuration
        api_response = api_instance.update_widget_config(id, widget_config=widget_config)
        print("The response of WidgetConfigApi->update_widget_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WidgetConfigApi->update_widget_config: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of widget configuration to update
widget_config WidgetConfig Widget configuration [optional]

Return type

WidgetConfig

Authorization

jwt

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 successful operation -
400 Bad request, JSON required or not enough parameters -
404 Widget configuration not found -

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