AssertionFailureOnField is a union datatype based on the different ways in which an assertion may fail. You'd use the parameters of FieldUnexpectedlyPresent, or FieldHadUnexpectedValue, or FieldHadConflictingAssertions, or AssertionOnFieldWasOrphaned datatype. Below are the tables for each datatype:

Table: FieldUnexpectedlyPresent

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
actualValuestringyes Long-TermThe value that the field contained.
fieldNamestringyes Long-TermThe field being asserted on.

Table: FieldHadUnexpectedValue

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
actualValuestring  Long-TermThe actual value of the field. Note that this is null in the case where the field wasn't present.
expectedValuestringyes Long-TermThe value that was asserted to be contained in the field.
fieldNamestringyes Long-TermThe field being asserted on.

Table: FieldHadConflictingAssertions

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
fieldNamestringyes Long-TermThe field being asserted on.

Table: AssertionOnFieldWasOrphaned

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 23, 2024
fieldNamestringyes Long-TermThe name of the field which is being asserted.