This document describes how to upload and download test cases for your integrations. For information about test cases, supported test configurations, and its limitations, see Introduction to test cases.
This predefined role contains
the permissions required to upload and download test cases. To see the exact permissions that are
required, expand the Required permissions section:
Required permissions
The following permissions are required to upload and download test cases:
Upload a test case:
integrations.googleapis.com/testCases.create
Download a test case:
integrations.googleapis.com/testCases.get
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis document explains how to upload and download test cases for Application Integration, which are subject to the "Pre-GA Offerings Terms" with potential limited support, as detailed in the Service Specific Terms.\u003c/p\u003e\n"],["\u003cp\u003eUploading and downloading test cases requires the \u003ccode\u003eApplication Integration Editor\u003c/code\u003e IAM role, which grants specific permissions such as \u003ccode\u003eintegrations.googleapis.com/testCases.create\u003c/code\u003e for uploads and \u003ccode\u003eintegrations.googleapis.com/testCases.get\u003c/code\u003e for downloads, and can be substituted by custom or other predefined roles.\u003c/p\u003e\n"],["\u003cp\u003eTo upload a test case, you can either use the Google Cloud console by navigating to the integration editor and selecting "Upload a test case", or by using the API method \u003ccode\u003eprojects.locations.integrations.versions.testCases.upload\u003c/code\u003e with the relevant parameters, ensuring the test case is in \u003ccode\u003e.json\u003c/code\u003e or \u003ccode\u003e.yaml\u003c/code\u003e format.\u003c/p\u003e\n"],["\u003cp\u003eDownloading a test case can be achieved through the Google Cloud console by selecting the desired test case from the "Test Cases" pane within the integration editor and clicking "Download", or via the API method \u003ccode\u003eprojects.locations.integrations.versions.testCases.download\u003c/code\u003e, specifying the project ID, location, integration name, integration version, and test case ID.\u003c/p\u003e\n"],["\u003cp\u003eAfter understanding how to manage test cases, you can learn about creating, configuring, running, copying and deleting test cases.\u003c/p\u003e\n"]]],[],null,["# Upload and download test cases\n\nSee the [supported connectors](/integration-connectors/docs/connector-reference-overview) for Application Integration.\n\nUpload and download test cases\n==============================\n\n|\n| **Preview\n| --- Test cases**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nThis document describes how to upload and download test cases for your integrations. For information about test cases, supported test configurations, and its limitations, see [Introduction to test cases](/application-integration/docs/test-cases).\n\nBefore you begin\n----------------\n\n-\n\n To get the permissions that\n you need to upload and download test cases,\n\n ask your administrator to grant you the\n\n\n [Application Integration Editor](/iam/docs/roles-permissions/integrations#integrations.integrationEditor) (`roles/integrations.integrationEditor`)\n IAM role on project.\n\n\n For more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\n This predefined role contains\n\n the permissions required to upload and download test cases. To see the exact permissions that are\n required, expand the **Required permissions** section:\n\n\n #### Required permissions\n\n The following permissions are required to upload and download test cases:\n - Upload a test case: ` integrations.googleapis.com/testCases.create `\n - Download a test case: ` integrations.googleapis.com/testCases.get`\n\n\n You might also be able to get\n these permissions\n with [custom roles](/iam/docs/creating-custom-roles) or\n other [predefined roles](/iam/docs/roles-overview#predefined).\n- To download a test case, ensure that you have a test case in the integration. For information about how to create a test case, see [Create Test Cases](/application-integration/docs/create-test-cases).\n\nUpload a test case\n------------------\n\nTo upload a test case, select one of the following options:\n\n### Console\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration for which you want to create a test. This opens the integration in the *integration editor*.\n\n4. To upload a test case from your local machine, from the **Test Case** list, select **Upload a test case**.\n\n### API\n\nCall the [`projects.locations.integrations.versions.testCases.upload` method](/application-integration/docs/reference/rest/v1/projects.locations.integrations.versions.testCases/upload) and provide any relevant parameters. For example: \n\n```sh\nPOST https://integrations.googleapis.com/v1/{parent=projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/versions/INTEGRATION_VERSION}/testCases:upload\n```\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the ID of the Google Cloud project\n- \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: the region where the integration is located\n- \u003cvar translate=\"no\"\u003eINTEGRATION_NAME\u003c/var\u003e: the name of the integration\n- \u003cvar translate=\"no\"\u003eINTEGRATION_VERSION\u003c/var\u003e: the version of the integration\n\nThe request body contains the content of the file in a string format and the file format. The valid file formats are `.json` and `.yaml`.\n\nDownload a test case\n--------------------\n\nTo download a test case for an integration version, select one of the following options:\n\n### Console\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration that contains test cases. This opens the integration in the *integration editor*.\n\n4. Click **Test Case** and then click **Open test cases** . The **Test Cases** pane appears with a list of test cases for the current integration version.\n5. Select the test case that you want to download. In the Integration editor page, the designer canvas displays **Test case mode is active**.\n\n6. Click download **Download**.\n\n### API\n\nCall the [`projects.locations.integrations.versions.testCases.download` method](/application-integration/docs/reference/rest/v1/projects.locations.integrations.versions.testCases/download). For example: \n\n```sh\nPOST https://integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/INTEGRATION_NAME/versions/INTEGRATION_VERSION/testCases/TEST_CASE_ID\n```\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: the ID of the Google Cloud project\n- \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: the region where the integration is located\n- \u003cvar translate=\"no\"\u003eINTEGRATION_NAME\u003c/var\u003e: the name of the integration\n- \u003cvar translate=\"no\"\u003eINTEGRATION_VERSION\u003c/var\u003e: the version of the integration\n- \u003cvar translate=\"no\"\u003eTEST_CASE_ID\u003c/var\u003e: the ID of the test case that you want download\n\nWhat's next\n-----------\n\n- Learn about [test cases](/application-integration/docs/test-cases).\n- Learn how to do the following:\n\n - [Create test cases](/application-integration/docs/create-test-cases).\n - [Configure test cases](/application-integration/docs/configure-test-cases).\n - [Run a test case](/application-integration/docs/run-test-cases) and [view test case execution logs](/application-integration/docs/integration-execution-logs#view-integration-execution-logs).\n - [Copy](/application-integration/docs/manage-test-cases#copy) and [delete](/application-integration/docs/manage-test-cases#delete) test cases."]]
