/AWS1/CL_CNK=>DELETEFIELD()
¶
About DeleteField¶
Deletes a field from a cases template. You can delete up to 100 fields per domain.
After a field is deleted:
-
You can still retrieve the field by calling
BatchGetField
. -
You cannot update a deleted field by calling
UpdateField
; it throws aValidationException
. -
Deleted fields are not included in the
ListFields
response. -
Calling
CreateCase
with a deleted field throws aValidationException
denoting which field IDs in the request have been deleted. -
Calling
GetCase
with a deleted field ID returns the deleted field's value if one exists. -
Calling
UpdateCase
with a deleted field ID throws aValidationException
if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (usingemptyValue: {}
) the field's value from the case. -
GetTemplate
does not return field IDs for deleted fields. -
GetLayout
does not return field IDs for deleted fields. -
Calling
SearchCases
with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. -
Calling
SearchCases
with asearchTerm
value that matches a deleted field's value on a case returns the case in the response. -
Calling
BatchPutFieldOptions
with a deleted field ID throw aValidationException
. -
Calling
GetCaseEventConfiguration
does not return field IDs for deleted fields.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_DOMAINID
TYPE /AWS1/CNKDOMAINID
/AWS1/CNKDOMAINID
¶
The unique identifier of the Cases domain.
IV_FIELDID
TYPE /AWS1/CNKFIELDID
/AWS1/CNKFIELDID
¶
Unique identifier of the field.