SOAP API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
AllowFieldTruncationHeader
Specifies that for some fields, when a string is too
large, the operation fails. Without the header, strings for these fields are
truncated.
The AllowFieldTruncationHeader header affects the
following datatypes:
- anyType, if it represents one of the other datatypes in this list
- encryptedstring
- multipicklist
- phone
- picklist
- string
- textarea
In API versions previous to 15.0, if a value for one of the listed fields is too large, the value is truncated.
For API version 15.0 and later, if a value is too large, the operation fails and the fault code STRING_TOO_LONG is returned. AllowFieldTruncationHeader allows you to specify that the previous behavior, truncation, be used instead of the new behavior in API versions 15.0 and later.
This header has no effect in versions 14.0 and earlier.
API Calls
convertLead(), create(), merge(), process(), undelete(), update(), and upsert()
Apex: executeanonymous()
Fields
Sample Code—Java
To create an account with a name that is too long for the Name field, use the AllowFieldTruncation header.
This sample:
- Creates an Account object with a name that exceeds the field limit of 255 characters.
- Sends the create call, which fails because of the name field length.
- Sets the AllowFieldTruncationHeader to true and retries the account creation, which succeeds.
public void allowFieldTruncationSample() {
try {
Account account = new Account();
// Construct a string that is 256 characters long.
// Account.Name's limit is 255 characters.
String accName = "";
for (int i = 0; i < 256; i++) {
accName += "a";
}
account.setName(accName);
// Construct an array of SObjects to hold the accounts.
SObject[] sObjects = new SObject[1];
sObjects[0] = account;
// Attempt to create the account. It will fail in API version 15.0
// and above because the account name is too long.
SaveResult[] results = connection.create(sObjects);
System.out.println("The call failed because: "
+ results[0].getErrors()[0].getMessage());
// Now set the SOAP header to allow field truncation.
connection.setAllowFieldTruncationHeader(true);
// Attempt to create the account now.
results = connection.create(sObjects);
System.out.println("The call: " + results[0].isSuccess());
} catch (ConnectionException ce) {
ce.printStackTrace();
}
}