Method: legacyFederatedCases.legacyFetchCasesToSync

Full name: projects.locations.instances.legacyFederatedCases.legacyFetchCasesToSync

Returns a batch of cases from a secondary instance that need to be synchronized into the primary platform's federated store. This method is typically called by automated synchronization integrations running on remote instances.

HTTP request


GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/legacyFederatedCases:legacyFetchCasesToSync

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of LegacyFederatedCases.

Query parameters

Parameters
pageToken

string

Optional. A page token, received from a previous legacyFederatedCases.legacyFetchCasesToSync call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to legacyFederatedCases.legacyFetchCasesToSync must match the call that provided the page token.
pageSize

integer

Optional. optional pageSize

Request body

The request body must be empty.

Response body

Response message for legacyFederatedCases.legacyFetchCasesToSync.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "legacyFederatedCases": [
    {
      object (LegacyFederatedCase)
    }
  ],
  "nextPageToken": string,
  "executionMessage": string
}
Fields
legacyFederatedCases[]

object (LegacyFederatedCase)

Output only. page of requested cases
nextPageToken

string

Output only. A token that can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
executionMessage

string

Output only. execution message for logging

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.legacyFederatedCases.fetchCasesToSync

For more information, see the IAM documentation.