Skip to content

List Field Options

connectcases_list_field_options R Documentation

Lists all of the field options for a field identifier in the domain

Description

Lists all of the field options for a field identifier in the domain.

Usage

connectcases_list_field_options(domainId, fieldId, maxResults,
  nextToken, values)

Arguments

domainId

[required] The unique identifier of the Cases domain.

fieldId

[required] The unique identifier of a field.

maxResults

The maximum number of results to return per page.

nextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

values

A list of FieldOption values to filter on for list_field_options.

Value

A list with the following syntax:

list(
  nextToken = "string",
  options = list(
    list(
      active = TRUE|FALSE,
      name = "string",
      value = "string"
    )
  )
)

Request syntax

svc$list_field_options(
  domainId = "string",
  fieldId = "string",
  maxResults = 123,
  nextToken = "string",
  values = list(
    "string"
  )
)