Deletes a field from a cases template¶

Description¶

Deletes a field from a cases template.

After a field is deleted:

• You can still retrieve the field by calling batch_get_field.
• You cannot update a deleted field by calling update_field; it throws a ValidationException.
• Deleted fields are not included in the list_fields response.
• Calling create_case with a deleted field throws a ValidationException denoting which field identifiers in the request have been deleted.
• Calling get_case with a deleted field identifier returns the deleted field's value if one exists.
• Calling update_case with a deleted field ID throws a ValidationException if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using emptyValue: {}) the field's value from the case.
• get_template does not return field IDs for deleted fields.
• get_layout does not return field IDs for deleted fields.
• Calling search_cases 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 search_cases with a searchTerm value that matches a deleted field's value on a case returns the case in the response.
• Calling batch_put_field_options with a deleted field ID throw a ValidationException.
• Calling get_case_event_configuration does not return field IDs for deleted fields.

Usage¶

connectcases_delete_field(domainId, fieldId)

Arguments¶

• domainId

  [required] The unique identifier of the Cases domain.

• fieldId

  [required] Unique identifier of the field.

Value¶

An empty list.

Request syntax¶

svc$delete_field(
  domainId = "string",
  fieldId = "string"
)