updateField method

Future<void> updateField({
  1. required String domainId,
  2. required String fieldId,
  3. FieldAttributes? attributes,
  4. String? description,
  5. String? name,
})

Updates the properties of an existing field.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter domainId : The unique identifier of the Cases domain.

Parameter fieldId : The unique identifier of a field.

Parameter attributes : Union of field attributes.

Parameter description : The description of a field.

Parameter name : The name of the field.

Implementation

Future<void> updateField({
  required String domainId,
  required String fieldId,
  FieldAttributes? attributes,
  String? description,
  String? name,
}) async {
  final $payload = <String, dynamic>{
    if (attributes != null) 'attributes': attributes,
    if (description != null) 'description': description,
    if (name != null) 'name': name,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PUT',
    requestUri:
        '/domains/${Uri.encodeComponent(domainId)}/fields/${Uri.encodeComponent(fieldId)}',
    exceptionFnMap: _exceptionFns,
  );
}