REST API Reference

Back Next

Updating fields in flat files

Use the fields resource to update fields in a source or target object from a flat file connection.

POST request

Use one of the following URIs:

For a source object, use

/api/v2/connection/source/<id>/field/<objectName>

For a target object, use

/api/v2/connection/target/<id>/field/<objectName>

When you update the fields in the object, the flat file attributes in the request override the default attributes for the object.

The following table describes the attributes you can include in the flatFileAttrs object that you specify in the request:

Field	Type	Required	Description
id	Long	Yes	Field ID.
delimiter	String	Yes	Character used to separate fields.
textQualifier	String	Yes	Quote character that defines the boundaries of text strings.
escapeChar	String	Yes	Character immediately preceding a field delimiter character embedded in an unquoted string, or immediately preceding the quote character in a quoted string.
headerLineNo	Int	Yes	Number of header lines.
firstDataRow	Int	Yes	The row number where the data begins in the file.
rowDelimiter	Int	--	Line break character. Enter the decimal code for an ASCII character between 1 and 32. Default is 10, which is the line feed character.
consecutiveDelimiter	Boolean	--	Indicates whether one or more consecutive delimiters are treated as one. Default is false.
multiDelimitersAsAnd	Boolean	--	If the delimiter you specify is more than one character, indicates whether the characters are treated as a single delimiter or multiple delimiters. Default is true.

POST request example

To update fields in a flat file source object, you might use the following request:

POST <serverUrl>/api/v2/connection/source/0000010B000000000021/field/test_precision.csv
1.0
Content-Type: application/xml
Accept: application/xml
icSessionId
{
    "@type": "flatFileAttrs",
    "delimiter": ",",
    "textQualifier": "'",
    "escapeChar": "\\"
}

Fields

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal