Method: formDynamicParameters.list

Full name: projects.locations.instances.formDynamicParameters.list

Lists all FormDynamicParameters defined in the instance. Use this method to discover the dynamic field configurations currently active for different investigation forms.

HTTP request


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

Path parameters

Parameters
parent

string

Required. The instance to list FormDynamicParameters for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of FormDynamicParameters to return. The service may return fewer than this value. If unspecified, at most 50 FormDynamicParameters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

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

When paginating, all other parameters provided to formDynamicParameters.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of FormDynamicParameters.
orderBy

string

Optional. Configures ordering of FormDynamicParameters in the response.
expand

string

Optional. Expand field for getting related data. Supported values: * relatedCustomField example: "?expand=relatedCustomField"

Request body

The request body must be empty.

Response body

Response message for formDynamicParameters.list.

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

JSON representation 
{
  "formDynamicParameters": [
    {
      object (FormDynamicParameter)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
formDynamicParameters[]

object (FormDynamicParameter)

The list of FormDynamicParameters. Ordered by Id by default.
nextPageToken

string

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

integer

The total number of FormDynamicParameters includes filter without pagination.

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.formDynamicParameters.get

For more information, see the IAM documentation.