Method: projects.locations.agents.testCases.export

Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

HTTP request

POST https://{endpoint}/v3/{parent=projects/*/locations/*/agents/*}/testCases:export

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The agent where to export test cases from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.testcases.export

Request body

The request body contains data with the following structure:

JSON representation 
{
  "dataFormat": enum (DataFormat),
  "filter": string,

  // Union field destination can be only one of the following:
  "gcsUri": string
  // End of list of possible types for union field destination.
}
Fields
dataFormat

enum (DataFormat)

The data format of the exported test cases. If not specified, BLOB is assumed.
filter

string

The filter expression used to filter exported test cases, see API Filtering. The expression is case insensitive and supports the following syntax:

name = [OR name = ] ...

For example:

  • "name = t1 OR name = t2" matches the test case with the exact resource name "t1" or "t2".
Union field destination. The destination to export. destination can be only one of the following:
gcsUri

string

The Google Cloud Storage URI to export the test cases to. The format of this URI must be gs://<bucket-name>/<object-name>. If unspecified, the serialized test cases is returned inline.

Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see Dialogflow access control.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.

DataFormat

Data format of the exported test cases.

Enums
DATA_FORMAT_UNSPECIFIED Unspecified format.
BLOB Raw bytes.
JSON JSON format.