Method: projects.locations.instances.importRegisteredParties

Imports the list of registered parties. See Create and manage instances for information on the input schema and response for this method.

HTTP request

POST https://financialservices.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:importRegisteredParties

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full path to the Instance resource in this API. format: "projects/{project}/locations/{location}/instances/{instance}"

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

  • financialservices.v1instances.importRegisteredParties

Request body

The request body contains data with the following structure:

JSON representation 
{
  "partyTables": [
    string
  ],
  "mode": enum (UpdateMode),
  "validateOnly": boolean,
  "lineOfBusiness": enum (LineOfBusiness)
}
Fields
partyTables[]

string

Required. List of BigQuery tables. Union of tables will be taken if there is more than one table. VPC-SC restrictions apply. format: "bq://{project}.{bqDatasetID}.{bqTableID}"
mode

enum (UpdateMode)

Required. Mode of the request.
validateOnly

boolean

Optional. Is the request will not register the parties, just determine what woud happen.
lineOfBusiness

enum (LineOfBusiness)

Required. LineOfBusiness for the specified registered parties.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • financialservices.v1instances.importRegisteredParties

For more information, see the IAM documentation.

UpdateMode

UpdateMode controls the behavior for instances.importRegisteredParties.

Enums
UPDATE_MODE_UNSPECIFIED Default mode.
REPLACE Replace parties that are removable in Parties Table with new parties.
APPEND Add new parties to Parties Table.