openapi_client.EventStreamApi

All URIs are relative to http://localhost

Method	HTTP request	Description
event_service_publish	POST /api/-/eventservice/events	Publish a Pulse event.
event_service_publish_ui_event	POST /api/-/eventservice/publishUIEvent	Publish a UI event.

event_service_publish

TableauEventserviceV1PublishResponse event_service_publish(x_tableau_auth=x_tableau_auth, tableau_eventservice_v1_publish_request=tableau_eventservice_v1_publish_request)

Publish a Pulse event.

Publish a new event on the Pulse Event Stream.

Example

import openapi_client
from openapi_client.models.tableau_eventservice_v1_publish_request import TableauEventserviceV1PublishRequest
from openapi_client.models.tableau_eventservice_v1_publish_response import TableauEventserviceV1PublishResponse
from openapi_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 = openapi_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.EventStreamApi(api_client)
    x_tableau_auth = 'x_tableau_auth_example' # str |  (optional)
    tableau_eventservice_v1_publish_request = openapi_client.TableauEventserviceV1PublishRequest() # TableauEventserviceV1PublishRequest |  (optional)

    try:
        # Publish a Pulse event.
        api_response = api_instance.event_service_publish(x_tableau_auth=x_tableau_auth, tableau_eventservice_v1_publish_request=tableau_eventservice_v1_publish_request)
        print("The response of EventStreamApi->event_service_publish:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventStreamApi->event_service_publish: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_tableau_auth	str		[optional]
tableau_eventservice_v1_publish_request	TableauEventserviceV1PublishRequest		[optional]

Return type

TableauEventserviceV1PublishResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/vnd.tableau.eventservice.v1.PublishRequest+json
Accept: application/vnd.tableau.eventservice.v1.PublishResponse+json, application/json

HTTP response details

Status code	Description	Response headers
201	Successful.	-
400	Invalid Request. The requested was incorrect.	-
401	Unable to authenticate user. Credentials are missing or invalid.	-
500	Unknown error. There was an internal server error.	-
404	Bad Request. The requested resource could not be found.	-
503	Service unavailable.	-
0	Successful.	-

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

event_service_publish_ui_event

TableauEventserviceV1PublishUIEventResponse event_service_publish_ui_event(x_tableau_auth=x_tableau_auth, tableau_eventservice_v1_publish_ui_event_request=tableau_eventservice_v1_publish_ui_event_request)

Publish a UI event.

Publish a UI event on the Pulse Event Stream.