instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/architect/grammars Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of grammars, filtered by query parameters. Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
id = ['id_example'] # list[str] | ID (optional)
name = 'name_example' # str | Name (optional)
description = 'description_example' # str | Description (optional)
name_or_description = 'name_or_description_example' # str | Name or description (optional)
include_file_urls = True # bool | Include grammar language file URLs (optional)
try:
# Get a pageable list of grammars, filtered by query parameters
api_response = api_instance.get_architect_grammars(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, include_file_urls=include_file_urls)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_grammars: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/grammars Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new grammar | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.Grammar() # Grammar |
try:
# Create a new grammar
api_response = api_instance.post_architect_grammars(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_grammars: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete a grammar. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | grammar ID
try:
# Delete a grammar.
api_response = api_instance.delete_architect_grammar(grammar_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_grammar: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a grammar. Returns a specified grammar | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | grammar ID
include_file_urls = True # bool | Include grammar language file URLs (optional)
try:
# Get a grammar
api_response = api_instance.get_architect_grammar(grammar_id, include_file_urls=include_file_urls)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_grammar: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a grammar | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | grammar ID
body = PureCloudPlatformClientV2.Grammar() # Grammar | (optional)
try:
# Updates a grammar
api_response = api_instance.patch_architect_grammar(grammar_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->patch_architect_grammar: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new language for a given grammar | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
body = PureCloudPlatformClientV2.GrammarLanguage() # GrammarLanguage |
try:
# Create a new language for a given grammar
api_response = api_instance.post_architect_grammar_languages(grammar_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_grammar_languages: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete specified grammar language | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
try:
# Delete specified grammar language
api_instance.delete_architect_grammar_language(grammar_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_grammar_language: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a grammar language. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
try:
# Get a grammar language.
api_response = api_instance.get_architect_grammar_language(grammar_id, language_code)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_grammar_language: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a grammar language | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
body = PureCloudPlatformClientV2.GrammarLanguageUpdate() # GrammarLanguageUpdate | (optional)
try:
# Updates a grammar language
api_response = api_instance.patch_architect_grammar_language(grammar_id, language_code, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->patch_architect_grammar_language: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Genesys Cloud Python SDK. | Genesys describes this as an API used to: Clear the DTMF mode file for the grammar language if there is one | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
try:
# Clear the DTMF mode file for the grammar language if there is one
api_instance.delete_architect_grammar_language_files_dtmf(grammar_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_grammar_language_files_dtmf: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Genesys Cloud Python SDK. | Genesys describes this as an API used to: Creates a presigned URL for uploading a grammar DTMF mode file | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
body = PureCloudPlatformClientV2.GrammarFileUploadRequest() # GrammarFileUploadRequest | query
try:
# Creates a presigned URL for uploading a grammar DTMF mode file
api_response = api_instance.post_architect_grammar_language_files_dtmf(grammar_id, language_code, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_grammar_language_files_dtmf: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Genesys Cloud Python SDK. | Genesys describes this as an API used to: Clear the voice mode file for the grammar language if there is one | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
try:
# Clear the voice mode file for the grammar language if there is one
api_instance.delete_architect_grammar_language_files_voice(grammar_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_grammar_language_files_voice: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Genesys Cloud Python SDK. | Genesys describes this as an API used to: Creates a presigned URL for uploading a grammar voice mode file | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
grammar_id = 'grammar_id_example' # str | Grammar ID
language_code = 'language_code_example' # str | Language
body = PureCloudPlatformClientV2.GrammarFileUploadRequest() # GrammarFileUploadRequest | query
try:
# Creates a presigned URL for uploading a grammar voice mode file
api_response = api_instance.post_architect_grammar_language_files_voice(grammar_id, language_code, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_grammar_language_files_voice: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/ivrs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get IVR configs. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
name = 'name_example' # str | Name of the IVR to filter by. (optional)
dnis = 'dnis_example' # str | The phone number of the IVR to filter by. (optional)
schedule_group = 'schedule_group_example' # str | The Schedule Group of the IVR to filter by. (optional)
try:
# Get IVR configs.
api_response = api_instance.get_architect_ivrs(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, dnis=dnis, schedule_group=schedule_group)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_ivrs: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/ivrs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create IVR config. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.IVR() # IVR |
try:
# Create IVR config.
api_response = api_instance.post_architect_ivrs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_ivrs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/ivrs/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic ivr configuration information objects filterable by query parameters. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
id = ['id_example'] # list[str] | ID of the IVR to filter by. (optional)
name = 'name_example' # str | Name of the IVR to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a pageable list of basic ivr configuration information objects filterable by query parameters.
api_response = api_instance.get_architect_ivrs_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_ivrs_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete an IVR Config. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
ivr_id = 'ivr_id_example' # str | IVR id
try:
# Delete an IVR Config.
api_instance.delete_architect_ivr(ivr_id)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_ivr: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get an IVR config. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
ivr_id = 'ivr_id_example' # str | IVR id
try:
# Get an IVR config.
api_response = api_instance.get_architect_ivr(ivr_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_ivr: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update an IVR Config. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
ivr_id = 'ivr_id_example' # str | IVR id
body = PureCloudPlatformClientV2.IVR() # IVR |
try:
# Update an IVR Config.
api_response = api_instance.put_architect_ivr(ivr_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_ivr: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/prompts Genesys Cloud Python SDK. | Genesys describes this as an API used to: Batch-delete a list of prompts. Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
id = ['id_example'] # list[str] | List of Prompt IDs
try:
# Batch-delete a list of prompts
api_response = api_instance.delete_architect_prompts(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_prompts: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/prompts Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of user prompts. The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = ['name_example'] # list[str] | Name (optional)
description = 'description_example' # str | Description (optional)
name_or_description = 'name_or_description_example' # str | Name or description (optional)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True)
include_resources = True # bool | Include the resources for each system prompt (optional) (default to True)
language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional)
try:
# Get a pageable list of user prompts
api_response = api_instance.get_architect_prompts(page_number=page_number, page_size=page_size, name=name, description=description, name_or_description=name_or_description, sort_by=sort_by, sort_order=sort_order, include_media_uris=include_media_uris, include_resources=include_resources, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_prompts: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/prompts Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new user prompt | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.Prompt() # Prompt |
try:
# Create a new user prompt
api_response = api_instance.post_architect_prompts(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_prompts: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete specified user prompt | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
all_resources = True # bool | Whether or not to delete all the prompt resources (optional)
try:
# Delete specified user prompt
api_instance.delete_architect_prompt(prompt_id, all_resources=all_resources)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_prompt: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get specified user prompt | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True)
include_resources = True # bool | Include the resources for each system prompt (optional) (default to True)
language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional)
try:
# Get specified user prompt
api_response = api_instance.get_architect_prompt(prompt_id, include_media_uris=include_media_uris, include_resources=include_resources, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_prompt: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update specified user prompt | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
body = PureCloudPlatformClientV2.Prompt() # Prompt |
try:
# Update specified user prompt
api_response = api_instance.put_architect_prompt(prompt_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_prompt: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/prompts/{promptId}/history Genesys Cloud Python SDK. | Genesys describes this as an API used to: Generate prompt history. Asynchronous. Notification topic: v2.architect.prompts.{promptId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
try:
# Generate prompt history
api_response = api_instance.post_architect_prompt_history(prompt_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_prompt_history: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/history/{historyId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get generated prompt history | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
history_id = 'history_id_example' # str | History request ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_order = ''desc'' # str | Sort order (optional) (default to 'desc')
sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp')
action = ['action_example'] # list[str] | Flow actions to include (omit to include all) (optional)
try:
# Get generated prompt history
api_response = api_instance.get_architect_prompt_history_history_id(prompt_id, history_id, page_number=page_number, page_size=page_size, sort_order=sort_order, sort_by=sort_by, action=action)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_prompt_history_history_id: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/resources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of user prompt resources. The returned list is pageable, and query parameters can be used for filtering. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a pageable list of user prompt resources
api_response = api_instance.get_architect_prompt_resources(prompt_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_prompt_resources: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/prompts/{promptId}/resources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new user prompt resource | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
body = PureCloudPlatformClientV2.PromptAssetCreate() # PromptAssetCreate |
try:
# Create a new user prompt resource
api_response = api_instance.post_architect_prompt_resources(prompt_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_prompt_resources: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete specified user prompt resource | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
try:
# Delete specified user prompt resource
api_instance.delete_architect_prompt_resource(prompt_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_prompt_resource: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get specified user prompt resource | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
try:
# Get specified user prompt resource
api_response = api_instance.get_architect_prompt_resource(prompt_id, language_code)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_prompt_resource: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update specified user prompt resource | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
body = PureCloudPlatformClientV2.PromptAsset() # PromptAsset |
try:
# Update specified user prompt resource
api_response = api_instance.put_architect_prompt_resource(prompt_id, language_code, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_prompt_resource: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete specified user prompt resource audio | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
try:
# Delete specified user prompt resource audio
api_instance.delete_architect_prompt_resource_audio(prompt_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_prompt_resource_audio: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedulegroups Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a list of schedule groups. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
name = 'name_example' # str | Name of the Schedule Group to filter by. (optional)
schedule_ids = 'schedule_ids_example' # str | A comma-delimited list of Schedule IDs to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a list of schedule groups.
api_response = api_instance.get_architect_schedulegroups(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, schedule_ids=schedule_ids, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedulegroups: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/schedulegroups Genesys Cloud Python SDK. | Genesys describes this as an API used to: Creates a new schedule group | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.ScheduleGroup() # ScheduleGroup |
try:
# Creates a new schedule group
api_response = api_instance.post_architect_schedulegroups(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_schedulegroups: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedulegroups/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic schedule group configuration information objects filterable by query parameters. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
id = ['id_example'] # list[str] | ID of the schedule group to filter by. (optional)
name = 'name_example' # str | Name of the schedule group to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
api_response = api_instance.get_architect_schedulegroups_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedulegroups_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Deletes a schedule group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID
try:
# Deletes a schedule group by ID
api_instance.delete_architect_schedulegroup(schedule_group_id)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_schedulegroup: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Gets a schedule group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID
try:
# Gets a schedule group by ID
api_response = api_instance.get_architect_schedulegroup(schedule_group_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedulegroup: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a schedule group by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID
body = PureCloudPlatformClientV2.ScheduleGroup() # ScheduleGroup |
try:
# Updates a schedule group by ID
api_response = api_instance.put_architect_schedulegroup(schedule_group_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_schedulegroup: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedules Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a list of schedules. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
name = 'name_example' # str | Name of the Schedule to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a list of schedules.
api_response = api_instance.get_architect_schedules(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedules: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/schedules Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new schedule. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.Schedule() # Schedule |
try:
# Create a new schedule.
api_response = api_instance.post_architect_schedules(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_schedules: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedules/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic schedule configuration information objects filterable by query parameters. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC')
id = ['id_example'] # list[str] | ID of the schedule group to filter by. (optional)
name = 'name_example' # str | Name of the schedule group to filter by. (optional)
division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional)
try:
# Get a pageable list of basic schedule configuration information objects filterable by query parameters.
api_response = api_instance.get_architect_schedules_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedules_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete a schedule by id | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_id = 'schedule_id_example' # str | Schedule ID
try:
# Delete a schedule by id
api_instance.delete_architect_schedule(schedule_id)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_schedule: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a schedule by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_id = 'schedule_id_example' # str | Schedule ID
try:
# Get a schedule by ID
api_response = api_instance.get_architect_schedule(schedule_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_schedule: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update schedule by ID | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
schedule_id = 'schedule_id_example' # str | Schedule ID
body = PureCloudPlatformClientV2.Schedule() # Schedule |
try:
# Update schedule by ID
api_response = api_instance.put_architect_schedule(schedule_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_schedule: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/systemprompts Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get System Prompts | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
name = 'name_example' # str | Name (optional)
description = 'description_example' # str | Description (optional)
name_or_description = 'name_or_description_example' # str | Name or description (optional)
include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True)
include_resources = True # bool | Include the resources for each system prompt (optional) (default to True)
language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional)
try:
# Get System Prompts
api_response = api_instance.get_architect_systemprompts(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, description=description, name_or_description=name_or_description, include_media_uris=include_media_uris, include_resources=include_resources, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_systemprompts: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a system prompt | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | promptId
include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True)
include_resources = True # bool | Include the resources for each system prompt (optional) (default to True)
language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional)
try:
# Get a system prompt
api_response = api_instance.get_architect_systemprompt(prompt_id, include_media_uris=include_media_uris, include_resources=include_resources, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_systemprompt: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/systemprompts/{promptId}/history Genesys Cloud Python SDK. | Genesys describes this as an API used to: Generate system prompt history. Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | promptId
try:
# Generate system prompt history
api_response = api_instance.post_architect_systemprompt_history(prompt_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_systemprompt_history: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/history/{historyId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get generated prompt history | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | promptId
history_id = 'history_id_example' # str | History request ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_order = ''desc'' # str | Sort order (optional) (default to 'desc')
sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp')
action = ['action_example'] # list[str] | Flow actions to include (omit to include all) (optional)
try:
# Get generated prompt history
api_response = api_instance.get_architect_systemprompt_history_history_id(prompt_id, history_id, page_number=page_number, page_size=page_size, sort_order=sort_order, sort_by=sort_by, action=action)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_systemprompt_history_history_id: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/resources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get system prompt resources. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
try:
# Get system prompt resources.
api_response = api_instance.get_architect_systemprompt_resources(prompt_id, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_systemprompt_resources: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/architect/systemprompts/{promptId}/resources Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create system prompt resource override. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
body = PureCloudPlatformClientV2.SystemPromptAsset() # SystemPromptAsset |
try:
# Create system prompt resource override.
api_response = api_instance.post_architect_systemprompt_resources(prompt_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_architect_systemprompt_resources: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete a system prompt resource override. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
try:
# Delete a system prompt resource override.
api_instance.delete_architect_systemprompt_resource(prompt_id, language_code)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_architect_systemprompt_resource: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a system prompt resource. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
try:
# Get a system prompt resource.
api_response = api_instance.get_architect_systemprompt_resource(prompt_id, language_code)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_architect_systemprompt_resource: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a system prompt resource override. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
prompt_id = 'prompt_id_example' # str | Prompt ID
language_code = 'language_code_example' # str | Language
body = PureCloudPlatformClientV2.SystemPromptAsset() # SystemPromptAsset |
try:
# Updates a system prompt resource override.
api_response = api_instance.put_architect_systemprompt_resource(prompt_id, language_code, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_architect_systemprompt_resource: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/flows Genesys Cloud Python SDK. | Genesys describes this as an API used to: Batch-delete a list of flows. Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
id = ['id_example'] # list[str] | List of Flow IDs
try:
# Batch-delete a list of flows
api_response = api_instance.delete_flows(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_flows: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of flows, filtered by query parameters. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
type = ['type_example'] # list[str] | Type (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
id = ['id_example'] # list[str] | ID (optional)
name = 'name_example' # str | Name (optional)
description = 'description_example' # str | Description (optional)
name_or_description = 'name_or_description_example' # str | Name or description (optional)
publish_version_id = 'publish_version_id_example' # str | Publish version ID (optional)
editable_by = 'editable_by_example' # str | Editable by (optional)
locked_by = 'locked_by_example' # str | Locked by (optional)
locked_by_client_id = 'locked_by_client_id_example' # str | Locked by client ID (optional)
secure = 'secure_example' # str | Secure (optional)
deleted = False # bool | Include deleted (optional) (default to False)
include_schemas = False # bool | Include variable schemas (optional) (default to False)
published_after = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published after (optional)
published_before = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published before (optional)
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
try:
# Get a pageable list of flows, filtered by query parameters
api_response = api_instance.get_flows(type=type, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, publish_version_id=publish_version_id, editable_by=editable_by, locked_by=locked_by, locked_by_client_id=locked_by_client_id, secure=secure, deleted=deleted, include_schemas=include_schemas, published_after=published_after, published_before=published_before, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create flow | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.Flow() # Flow |
language = 'language_example' # str | Language (optional)
try:
# Create flow
api_response = api_instance.post_flows(body, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/checkin Genesys Cloud Python SDK. | Genesys describes this as an API used to: Check-in flow. Asynchronous. Notification topic: v2.flows.{flowId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
try:
# Check-in flow
api_response = api_instance.post_flows_actions_checkin(flow)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_checkin: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/checkout Genesys Cloud Python SDK. | Genesys describes this as an API used to: Check-out flow | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
try:
# Check-out flow
api_response = api_instance.post_flows_actions_checkout(flow)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_checkout: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/deactivate Genesys Cloud Python SDK. | Genesys describes this as an API used to: Deactivate flow | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
try:
# Deactivate flow
api_response = api_instance.post_flows_actions_deactivate(flow)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_deactivate: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/publish Genesys Cloud Python SDK. | Genesys describes this as an API used to: Publish flow. Asynchronous. Notification topic: v2.flows.{flowId} | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
version = 'version_example' # str | version (optional)
try:
# Publish flow
api_response = api_instance.post_flows_actions_publish(flow, version=version)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_publish: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/revert Genesys Cloud Python SDK. | Genesys describes this as an API used to: Revert flow | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
try:
# Revert flow
api_response = api_instance.post_flows_actions_revert(flow)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_revert: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/actions/unlock Genesys Cloud Python SDK. | Genesys describes this as an API used to: Unlock flow. Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this action. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow = 'flow_example' # str | Flow ID
try:
# Unlock flow
api_response = api_instance.post_flows_actions_unlock(flow)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_actions_unlock: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables Genesys Cloud Python SDK. | Genesys describes this as an API used to: Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
expand = 'expand_example' # str | Expand instructions for the result (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending')
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
name = 'exactMatch, beginsWith*, *endsWith, *contains*' # str | Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional)
try:
# Retrieve a list of datatables for the org
api_response = api_instance.get_flows_datatables(expand=expand, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, division_id=division_id, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatables: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/datatables Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new datatable with the specified json-schema definition. This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.org/ | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.DataTable() # DataTable | datatable json-schema
try:
# Create a new datatable with the specified json-schema definition
api_response = api_instance.post_flows_datatables(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_datatables: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
expand = 'expand_example' # str | Expand instructions for the result (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending')
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
name = 'exactMatch, beginsWith*, *endsWith, *contains*' # str | Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional)
try:
# Retrieve a list of datatables for the org
api_response = api_instance.get_flows_datatables_divisionviews(expand=expand, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, division_id=division_id, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatables_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/divisionviews/{datatableId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
expand = 'expand_example' # str | Expand instructions for the result (optional)
try:
# Returns a specific datatable by id
api_response = api_instance.get_flows_datatables_divisionview(datatable_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatables_divisionview: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: deletes a specific datatable by id. Deletes an entire datatable (including the schema and data) with a given datatableId | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
force = False # bool | force delete, even if in use (optional) (default to False)
try:
# deletes a specific datatable by id
api_instance.delete_flows_datatable(datatable_id, force=force)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_flows_datatable: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
expand = 'expand_example' # str | Expand instructions for the result (optional)
try:
# Returns a specific datatable by id
api_response = api_instance.get_flows_datatable(datatable_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Updates a specific datatable by id. Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
body = PureCloudPlatformClientV2.DataTable() # DataTable | datatable json-schema
expand = 'expand_example' # str | Expand instructions for the result (optional)
try:
# Updates a specific datatable by id
api_response = api_instance.put_flows_datatable(datatable_id, body, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_flows_datatable: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/export/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Begin an export process for exporting all rows from a datatable. Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
try:
# Begin an export process for exporting all rows from a datatable
api_response = api_instance.post_flows_datatable_export_jobs(datatable_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_datatable_export_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns the state information about an export job. Returns the state information about an export job. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
export_job_id = 'export_job_id_example' # str | id of export job
try:
# Returns the state information about an export job
api_response = api_instance.get_flows_datatable_export_job(datatable_id, export_job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable_export_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/import/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get all recent import jobs. Get all recent import jobs | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get all recent import jobs
api_response = api_instance.get_flows_datatable_import_jobs(datatable_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable_import_jobs: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/import/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Begin an import process for importing rows into a datatable. Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
body = PureCloudPlatformClientV2.DataTableImportJob() # DataTableImportJob | import job information
try:
# Begin an import process for importing rows into a datatable
api_response = api_instance.post_flows_datatable_import_jobs(datatable_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_datatable_import_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns the state information about an import job. Returns the state information about an import job. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
import_job_id = 'import_job_id_example' # str | id of import job
try:
# Returns the state information about an import job
api_response = api_instance.get_flows_datatable_import_job(datatable_id, import_job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable_import_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/rows Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns the rows for the datatable with the given id. Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
showbrief = True # bool | If true returns just the key value of the row (optional) (default to True)
sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending')
try:
# Returns the rows for the datatable with the given id
api_response = api_instance.get_flows_datatable_rows(datatable_id, page_number=page_number, page_size=page_size, showbrief=showbrief, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable_rows: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/rows Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" } | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
data_table_row = NULL # object |
try:
# Create a new row entry for the datatable.
api_response = api_instance.post_flows_datatable_rows(datatable_id, data_table_row)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_datatable_rows: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Delete a row entry. Deletes a row with a given rowId (the value of the key field). | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
row_id = 'row_id_example' # str | the key for the row
try:
# Delete a row entry
api_instance.delete_flows_datatable_row(datatable_id, row_id)
except ApiException as e:
print("Exception when calling ArchitectApi->delete_flows_datatable_row: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns a specific row for the datatable. Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
row_id = 'row_id_example' # str | The key for the row
showbrief = True # bool | if true returns just the key field for the row (optional) (default to True)
try:
# Returns a specific row for the datatable
api_response = api_instance.get_flows_datatable_row(datatable_id, row_id, showbrief=showbrief)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_datatable_row: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Update a row entry. Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" } | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
datatable_id = 'datatable_id_example' # str | id of datatable
row_id = 'row_id_example' # str | the key for the row
body = NULL # object | datatable row (optional)
try:
# Update a row entry
api_response = api_instance.put_flows_datatable_row(datatable_id, row_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_flows_datatable_row: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
type = ['type_example'] # list[str] | Type (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
id = ['id_example'] # list[str] | ID (optional)
name = 'name_example' # str | Name (optional)
publish_version_id = 'publish_version_id_example' # str | Publish version ID (optional)
published_after = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published after (optional)
published_before = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published before (optional)
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
include_schemas = False # bool | Include variable schemas (optional) (default to False)
try:
# Get a pageable list of basic flow information objects filterable by query parameters.
api_response = api_instance.get_flows_divisionviews(type=type, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, publish_version_id=publish_version_id, published_after=published_after, published_before=published_before, division_id=division_id, include_schemas=include_schemas)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_divisionviews: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/executions Genesys Cloud Python SDK. | Genesys describes this as an API used to: Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow_launch_request = PureCloudPlatformClientV2.FlowExecutionLaunchRequest() # FlowExecutionLaunchRequest |
try:
# Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
api_response = api_instance.post_flows_executions(flow_launch_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_executions: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/executions/{flowExecutionId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a flow execution's details. Flow execution details are available for several days after the flow is started. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
flow_execution_id = 'flow_execution_id_example' # str | flow execution ID
try:
# Get a flow execution's details. Flow execution details are available for several days after the flow is started.
api_response = api_instance.get_flows_execution(flow_execution_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_execution: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/instances/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.ExecutionDataRequest() # ExecutionDataRequest | Requested Flow Ids
expand = 'expand_example' # str | Expand various query types. (optional)
try:
# Start a process (job) that will prepare a list of execution data IDs for download.
api_response = api_instance.post_flows_instances_jobs(body, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_instances_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get the status and/or results of an asynchronous flow execution data retrieval job | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
job_id = 'job_id_example' # str | The asynchronous job ID
try:
# Get the status and/or results of an asynchronous flow execution data retrieval job
api_response = api_instance.get_flows_instances_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_job: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/instances/query Genesys Cloud Python SDK. | Genesys describes this as an API used to: Query the database of existing flow histories to look for particular flow criteria. Returns a list of matching flow histories up to 200 max. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.CriteriaQuery() # CriteriaQuery | query
index_only = True # bool | indexes only (optional)
page_size = 50 # int | number of results to return (optional) (default to 50)
try:
# Query the database of existing flow histories to look for particular flow criteria
api_response = api_instance.post_flows_instances_query(body, index_only=index_only, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_instances_query: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/querycapabilities Genesys Cloud Python SDK. | Genesys describes this as an API used to: Retrieve a list of capabilities that the org can use to query for execution data. Returns the queryable parameters that can be used to build a query for execution data. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
expand = 'expand_example' # str | Expand various query types. (optional)
try:
# Retrieve a list of capabilities that the org can use to query for execution data
api_response = api_instance.get_flows_instances_querycapabilities(expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_querycapabilities: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/settings/executiondata Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get the execution history enabled setting. Get the execution history enabled setting. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Get the execution history enabled setting.
api_response = api_instance.get_flows_instances_settings_executiondata()
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_settings_executiondata: %s\n" % e)``` |
Provide a Python example that uses the PATCH /api/v2/flows/instances/settings/executiondata Genesys Cloud Python SDK. | Genesys describes this as an API used to: Edit the execution history enabled setting. Edit the execution history enabled setting. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.ExecutionDataSettingsRequest() # ExecutionDataSettingsRequest | New Execution Data Setting
try:
# Edit the execution history enabled setting.
api_response = api_instance.patch_flows_instances_settings_executiondata(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->patch_flows_instances_settings_executiondata: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels Genesys Cloud Python SDK. | Genesys describes this as an API used to: Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow id | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
expand = ['expand_example'] # list[str] | Expand instructions for the result (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Number of entities to return. Maximum of 200. (optional) (default to 25)
try:
# Retrieve a list of LogLevels for the organization.
api_response = api_instance.get_flows_instances_settings_loglevels(expand=expand, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_settings_loglevels: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels/characteristics Genesys Cloud Python SDK. | Genesys describes this as an API used to: Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Gets the available flow log level characteristics for this organization.
api_response = api_instance.get_flows_instances_settings_loglevels_characteristics()
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_settings_loglevels_characteristics: %s\n" % e)``` |
Provide a Python example that uses the DELETE /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK. | Genesys describes this as an API used to: Resets the org log level to default, base. Resets the org log level to default, base | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Resets the org log level to default, base
api_instance.delete_flows_instances_settings_loglevels_default()
except ApiException as e:
print("Exception when calling ArchitectApi->delete_flows_instances_settings_loglevels_default: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK. | Genesys describes this as an API used to: Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
expand = ['expand_example'] # list[str] | Expand instructions for the result (optional)
try:
# Returns the flow default log level.
api_response = api_instance.get_flows_instances_settings_loglevels_default(expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instances_settings_loglevels_default: %s\n" % e)``` |
Provide a Python example that uses the PUT /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK. | Genesys describes this as an API used to: Edit the flow default log level. Edit the flow default log level. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.FlowLogLevelRequest() # FlowLogLevelRequest | New LogLevel settings
expand = ['expand_example'] # list[str] | Expand instructions for the result (optional)
try:
# Edit the flow default log level.
api_response = api_instance.put_flows_instances_settings_loglevels_default(body, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->put_flows_instances_settings_loglevels_default: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/instances/{instanceId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Start a process (job) to prepare a download of a singular flow execution data instance by Id. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
instance_id = 'instance_id_example' # str | Instance ID
expand = 'expand_example' # str | Expand various details. (optional)
try:
# Start a process (job) to prepare a download of a singular flow execution data instance by Id
api_response = api_instance.get_flows_instance(instance_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_instance: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/jobs Genesys Cloud Python SDK. | Genesys describes this as an API used to: Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
try:
# Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
api_response = api_instance.post_flows_jobs()
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_jobs: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/jobs/{jobId} Genesys Cloud Python SDK. | Genesys describes this as an API used to: Fetch Architect Job Status | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
job_id = 'job_id_example' # str | Job ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Fetch Architect Job Status
api_response = api_instance.get_flows_job(job_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_job: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/milestones Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of flow milestones, filtered by query parameters. Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
id = ['id_example'] # list[str] | ID (optional)
name = 'name_example' # str | Name (optional)
description = 'description_example' # str | Description (optional)
name_or_description = 'name_or_description_example' # str | Name or description (optional)
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
try:
# Get a pageable list of flow milestones, filtered by query parameters
api_response = api_instance.get_flows_milestones(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_milestones: %s\n" % e)``` |
Provide a Python example that uses the POST /api/v2/flows/milestones Genesys Cloud Python SDK. | Genesys describes this as an API used to: Create a flow milestone | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
body = PureCloudPlatformClientV2.FlowMilestone() # FlowMilestone | (optional)
try:
# Create a flow milestone
api_response = api_instance.post_flows_milestones(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->post_flows_milestones: %s\n" % e)``` |
Provide a Python example that uses the GET /api/v2/flows/milestones/divisionviews Genesys Cloud Python SDK. | Genesys describes this as an API used to: Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search. | ```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ArchitectApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = ''id'' # str | Sort by (optional) (default to 'id')
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
id = ['id_example'] # list[str] | ID (optional)
name = 'name_example' # str | Name (optional)
division_id = ['division_id_example'] # list[str] | division ID(s) (optional)
try:
# Get a pageable list of basic flow milestone information objects filterable by query parameters.
api_response = api_instance.get_flows_milestones_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ArchitectApi->get_flows_milestones_divisionviews: %s\n" % e)``` |
Subsets and Splits