2023-08-10
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.list
Flat Path: v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups
Parameter Order: parent
Path: v3beta1/{+parent}/transitionRouteGroups
Scopes:
Description: Returns the list of all transition route groups in the specified flow.
HTTP Method: GET
Parameters:
pageToken
Location: query
Type: string
Description: The next_page_token value returned from a previous list request.
parent
Location: path
Description: Required. The flow to list all transition route groups for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Required: Yes
languageCode
Type: string
Description: The language to list transition route groups for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location: query
pageSize
Format: int32
Type: integer
Description: The maximum number of items to return in a single page. By default 100 and at most 1000.
Location: query
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.create
Scopes:
Parameter Order: parent
HTTP Method: POST
Parameters:
languageCode
Description: The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location: query
Type: string
parent
Required: Yes
Type: string
Location: path
Description: Required. The flow to create an TransitionRouteGroup for. Format: `projects//locations//agents//flows/` or `projects//locations//agents/` for agent-level groups.
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Description: Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Flat Path: v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups
Path: v3beta1/{+parent}/transitionRouteGroups
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.get
Path: v3beta1/{+name}
Scopes:
Description: Retrieves the specified TransitionRouteGroup.
HTTP Method: GET
Parameters:
languageCode
Description: The language to retrieve the transition route group for. The following fields are language dependent: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Type: string
Location: query
name
Type: string
Location: path
Required: Yes
Description: Required. The name of the TransitionRouteGroup. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Flat Path: v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}
Parameter Order: name
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.delete
Path: v3beta1/{+name}
Parameters:
force
Type: boolean
Location: query
Description: This field has no effect for transition route group that no page is using. If the transition route group is referenced by any page: * If `force` is set to false, an error will be returned with message indicating pages that reference the transition route group. * If `force` is set to true, Dialogflow will remove the transition route group, as well as any reference to it.
name
Required: Yes
Description: Required. The name of the TransitionRouteGroup to delete. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/`.
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Location: path
Type: string
HTTP Method: DELETE
Description: Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
Flat Path: v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}
Scopes:
Parameter Order: name
▼ ▲ dialogflow.projects.locations.agents.transitionRouteGroups.patch
Parameters:
updateMask
Description: The mask to control which fields get updated.
Type: string
Format: google-fieldmask
Location: query
languageCode
Description: The language of the following fields in `TransitionRouteGroup`: * `TransitionRouteGroup.transition_routes.trigger_fulfillment.messages` * `TransitionRouteGroup.transition_routes.trigger_fulfillment.conditional_cases` If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/cx/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used.
Location: query
Type: string
name
Required: Yes
Description: The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.
Pattern: ^projects/[^/]+/locations/[^/]+/agents/[^/]+/transitionRouteGroups/[^/]+$
Location: path
Type: string
Flat Path: v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/transitionRouteGroups/{transitionRouteGroupsId}
Path: v3beta1/{+name}
HTTP Method: PATCH
Parameter Order: name
Scopes:
Description: Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).