ConnectCases / Client / list_field_options

list_field_options

ConnectCases.Client.list_field_options(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_field_options(
    domainId='string',
    fieldId='string',
    maxResults=123,
    nextToken='string',
    values=[
        'string',
    ]
)

Parameters:

• domainId (string) –

  [REQUIRED]

  The unique identifier of the Cases domain.

• fieldId (string) –

  [REQUIRED]

  The unique identifier of a field.

• maxResults (integer) – The maximum number of results to return per page.

• nextToken (string) – 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 (list) –

  A list of FieldOption values to filter on for ListFieldOptions .

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'options': [
        {
            'active': True|False,
            'name': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    The token for the next set of results. This is null if there are no more results to return.

  • options (list) –

    A list of FieldOption objects.

    • (dict) –

      Object for field Options information.

      • active (boolean) –

        Describes whether the FieldOption is active (displayed) or inactive.

      • name (string) –

        FieldOptionName has max length 100 and disallows trailing spaces.

      • value (string) –

        FieldOptionValue has max length 100 and must be alphanumeric with hyphens and underscores.

Exceptions

• ConnectCases.Client.exceptions.InternalServerException

• ConnectCases.Client.exceptions.ResourceNotFoundException

• ConnectCases.Client.exceptions.ValidationException

• ConnectCases.Client.exceptions.ThrottlingException

• ConnectCases.Client.exceptions.AccessDeniedException