Application Integration API (integrations:v1)

2024-09-26

10 new methods

Additions

    Methods
  • integrations.projects.locations.integrations.versions.testCases.listExecutions

      Description: Lists the results of all functional test executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

      Path: v1/{+parent}:executions

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executions

      HTTP Method: GET

      Parameters:

        readMask

          Description: Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.

          Type: string

          Location: query

          Format: google-fieldmask

        pageToken

          Location: query

          Description: Optional. The token returned in the previous response.

          Type: string

        pageSize

          Type: integer

          Location: query

          Description: Optional. The size of entries in the response.

          Format: int32

        filter

          Location: query

          Type: string

          Description: Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: "parameter_type" HAS \"string\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND test_case_id=\"testCaseId\"

        truncateParams

          Location: query

          Type: boolean

          Description: Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.

          Deprecated: Yes

        orderBy

          Description: Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".

          Type: string

          Location: query

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Required: Yes

          Location: path

          Description: Required. The parent resource name of the test case execution.

          Type: string

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • integrations.projects.locations.integrations.versions.testCases.delete

      Description: Deletes a test case

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Required: Yes

          Description: Required. ID for the test case to be deleted

          Type: string

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}

      Path: v1/{+name}

      Parameter Order: name

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • integrations.projects.locations.integrations.versions.testCases.list

      Parameter Order: parent

      Path: v1/{+parent}/testCases

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases

      Description: Lists all the test cases that satisfy the filters.

      Parameters:

        orderBy

          Type: string

          Location: query

          Description: Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time". Ascending sort order for "name".

        pageSize

          Format: int32

          Location: query

          Type: integer

          Description: Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.

        parent

          Description: Required. The parent resource where this TestCase was created.

          Location: path

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$

          Required: Yes

        filter

          Type: string

          Description: Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.

          Location: query

        pageToken

          Type: string

          Location: query

          Description: Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.

        readMask

          Format: google-fieldmask

          Type: string

          Location: query

          Description: Optional. The mask which specifies fields that need to be returned in the TestCases's response.

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • integrations.projects.locations.integrations.versions.testCases.patch

      HTTP Method: PATCH

      Parameter Order: name

      Description: Updates a test case

      Path: v1/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Required: Yes

          Description: Output only. Auto-generated primary key.

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

        updateMask

          Type: string

          Location: query

          Format: google-fieldmask

          Description: Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}

  • integrations.projects.locations.integrations.versions.testCases.executeTest

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest

      Description: Executes functional test

      Parameters:

        testCaseName

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Description: Required. Test case resource name

          Required: Yes

          Type: string

      HTTP Method: POST

      Path: v1/{+testCaseName}:executeTest

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: testCaseName

  • integrations.projects.locations.integrations.versions.testCases.takeoverEditLock

      Description: Clear the lock fields and assign them to current user

      Path: v1/{+name}:takeoverEditLock

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Location: path

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Description: Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}

  • integrations.projects.locations.integrations.versions.testCases.download

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        fileFormat

          Location: query

          Enum Descriptions:

        • Unspecified file format
        • JSON File Format
        • YAML File Format
        • Description: File format for download request.

          Enum:

        • FILE_FORMAT_UNSPECIFIED
        • JSON
        • YAML
        • Type: string

        name

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Description: Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}

          Location: path

      Path: v1/{+name}:download

      Description: Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download

      Parameter Order: name

  • integrations.projects.locations.integrations.versions.testCases.get

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}

      Path: v1/{+name}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$

          Description: Required. The ID of the test case to retrieve

          Location: path

      Description: Get a test case

      Parameter Order: name

  • integrations.projects.locations.integrations.versions.testCases.create

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new test case

      Parameters:

        parent

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$

          Description: Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}

          Location: path

          Required: Yes

        testCaseId

          Description: Required. Required

          Location: query

          Type: string

      Path: v1/{+parent}/testCases

      HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases

  • integrations.projects.locations.integrations.versions.testCases.upload

      Description: Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.

      HTTP Method: POST

      Path: v1/{+parent}/testCases:upload

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        parent

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$

          Location: path

          Description: Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload