ConnectCases / Client / batch_put_field_options

batch_put_field_options#

ConnectCases.Client.batch_put_field_options(**kwargs)#

Creates and updates a set of field options for a single select field in a Cases domain.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_field_options(
    domainId='string',
    fieldId='string',
    options=[
        {
            'active': True|False,
            'name': 'string',
            'value': 'string'
        },
    ]
)
Parameters:

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fieldId (string) –

    [REQUIRED]

    The unique identifier of a field.

  • options (list) –

    [REQUIRED]

    A list of FieldOption objects.

    • (dict) –

      Object for field Options information.

      • active (boolean) – [REQUIRED]

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

      • name (string) – [REQUIRED]

        FieldOptionName has max length 100 and disallows trailing spaces.

      • value (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'errors': [
        {
            'errorCode': 'string',
            'message': 'string',
            'value': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • errors (list) –

      A list of field errors.

      • (dict) –

        Object for field Options errors.

        • errorCode (string) –

          Error code from creating or updating field option.

        • message (string) –

          Error message from creating or updating field option.

        • value (string) –

          The field option value that caused the error.

Exceptions