REST API Reference

Back Next

Fields

A field is a subset of a data structure that represents a single data item. For example, a database table column is a field. Use this resource to request field details for a source or target object and to update the flat file attributes for a source or target object.

GET request

Request field details of a source object or a target object.

To request the field details of a source object, use the source connection ID or source connection name and the source object name. Use one of the following URIs:

/api/v2/connection/source/<id>/field/<object name>

/api/v2/connection/source/name/<name>/field/<object name>

To request the field details of a target object, use the target connection ID or target connection name and the target object name. Use one of the following URIs:

/api/v2/connection/target/<id>/field/<object name>

/api/v2/connection/target/name/<name>/field/<object name>

If you use the connection name in the URI and the connection name includes a space, replace the space with

%20

. For example:

/api/v2/connection/source/name/my%20connection/field/customer

You can also use the following URI, which accommodates searching for an object that includes a forward slash (/):

/api/v2/connection/<source or target>/<id>/fields?objectName=<objectName>

The object name is case-sensitive.

GET response

Returns the field object for each field in the requested object.

Returns the error object if errors occur.

The field object includes different information based on the connection type. The following attributes might be returned in a field object:

Field	Type	Description
id	Long	Field ID.
name	String	Field name.
type	String	Field type.
label	String	Field label.
parentObject	String	Parent object, if applicable.
precision	Int	Length of the field in bytes.
pcType	String	PowerCenter data type.
scale	Int	Number of digits after the decimal point for numeric values.
columnIndex	Int	Column index.
isKey	Boolean	Whether the field is a used as a key.
isExternalId	Boolean	Whether the field is used as an external ID.
isSfldLookup	Boolean	Whether the field is used as a Salesforce ID lookup field.
isNullible	Boolean	Whether the field can contain null values.
isUnique	Boolean	Whether the field requires unique values.
isCreateable	Boolean	Whether the field accepts new values.
isCalculated	Boolean	Whether the field is calculated.
isUpdateable	Boolean	Whether the field allows updates.
isFilterable	Boolean	Whether the field can be filtered.
linkedFields	String	For a masking task, the source field mapped to the input field of the mapplet.
relatedInfos		Information about related fields included in a fieldRelatedInfo object for each related field.
fieldId	Long	Included in the fieldRelatedInfo object. Field ID.
referenceObject	String	Included in the fieldRelatedInfo object. Object that includes the field.
relationshipName	String	Included in the fieldRelatedInfo object. Relationship to object.
references		Reference information included in a fieldRelatedInfo object for each related field.
fieldId	Long	Included in the fieldRelatedInfo object. Field ID.
referenceObject	String	Included in the fieldRelatedInfo object. Object that includes the field.
relationshipName	String	Included in the fieldRelatedInfo object. Relationship to object.
javaType	String	Java data type.
showLabel	Boolean	Whether to show the field label.
naturalOrder	Int	Position number of the field in the source.
customProperties		Custom properties for the field.

GET example

To get the field details for the Customer object available through the source connection (ID: 0002D420000000J), you might use the following request:

GET <serverUrl>/api/v2/connection/source/0002D420000000J/field/Customer
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>

A successful request returns the fields object for each field in the Customer source object.

POST request for flat file attributes

You can use a POST request to update flat file attributes for a flat file connection.

Use one of the following URI:

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

When you send a request to change flat file attributes, the flat file attributes provided in the request override the default attributes specified in the connection object.

To change flat file attributes, include the following information in the flatFileAttrs object:

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 for flat file attributes

To send a request for field information for a flat file connection, 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": "\\"
}

POST request for non-flat file formats

For Avro, Parquet, Orc, and JSON formats, you can receive field information by including the format type and optionally, the schema. If you don't include the schema, the schema format is inferred from the data file.

Use one of the following URIs:

/api/v2/connection/source/<id>/fields?objectName=<object name>
/api/v2/connection/target/<id>/fields?objectName=<object name>

You can use the following attributes in the dataFormat object:

Field	Type	Required	Description
formatId	String	Yes	Format type, for example, Avro.
schema	String	--	Schema format.

POST request example for a non-flat file formats

To send a request for field information for a Parquet connection, you might use a request that is similar to the following example:

POST <serverUrl>/api/v2/connection/source/0100000B00000000000F/fields?objectName=infa.qa.bucket%2Fcustomer.parquet
1.0
Content-Type: application/xml
Accept: application/xml
icSessionId: <icSessionId>
{
    "@type": "dataFormat",
    "dformatId": "Parquet",
    "schema": "message AllData_root { optional int32 c_custkey; optional binary c_name (UTF8); optional binary c_address (UTF8); optional int64 c_nationkey; optional binary c_phone (UTF8); optional double c_acctbal; optional binary c_mktsegment (UTF8); required binary c_comment (UTF8);}"
}

A successful response might look like the following example:

[
    {
        "@type": "field",
        "id": -1,
        "name": "c_custkey",
        "type": "parquet_int32",
        "uniqueName": "c_custkey",
        "label": "c_custkey",
        "parentObject": "customer_tgt.parquet",
        "pcType": "INTEGER",
        "precision": 10,
        "scale": 0,
        "columnIndex": -1,
        "isKey": false,
        "isExternalId": false,
        "isSfIdLookup": false,
        "isNullable": true,
        "isUnique": false,
        "isCreateable": false,
        "isUpdateable": true,
        "isFilterable": true,
        "isCalculated": false,
        "javaType": "java.lang.Integer",
        "showLabel": true,
        "naturalOrder": 0,
        "linkedFields": [],
        "relatedInfos": [],
        "references": []
    },
    {
        "@type": "field",
        "id": -1,
        "name": "c_address",
        "type": "parquet_string",
        "uniqueName": "c_address",
        "label": "c_address",
        "parentObject": "customer_tgt.parquet",
        "pcType": "NSTRING",
        "precision": 4000,
        "scale": 0,
        "columnIndex": -1,
        "isKey": false,
        "isExternalId": false,
        "isSfIdLookup": false,
        "isNullable": true,
        "isUnique": false,
        "isCreateable": false,
        "isUpdateable": true,
        "isFilterable": true,
        "isCalculated": false,
        "javaType": "java.lang.String",
        "showLabel": true,
        "naturalOrder": 2,
        "linkedFields": [],
        "relatedInfos": [],
        "references": []
    },
    {
        "@type": "field",
        "id": -1,
        "name": "c_nationkey",
        "type": "parquet_int64",
        "uniqueName": "c_nationkey",
        "label": "c_nationkey",
        "parentObject": "customer_tgt.parquet",
        "pcType": "BIGINT",
        "precision": 19,
        "scale": 0,
        "columnIndex": -1,
        "isKey": false,
        "isExternalId": false,
        "isSfIdLookup": false,
        "isNullable": true,
        "isUnique": false,
        "isCreateable": false,
        "isUpdateable": true,
        "isFilterable": true,
        "isCalculated": false,
        "javaType": "java.math.BigInteger",
        "showLabel": true,
        "naturalOrder": 3,
        "linkedFields": [],
        "relatedInfos": [],
        "references": []
    },
    {
        "@type": "field",
        "id": -1,
        "name": "FileName",
        "type": "string",
        "uniqueName": "FileName",
        "label": "FileName",
        "parentObject": "customer_tgt.parquet",
        "pcType": "NSTRING",
        "precision": 1024,
        "scale": 0,
        "columnIndex": -1,
        "isKey": false,
        "isExternalId": false,
        "isSfIdLookup": false,
        "isNullable": false,
        "isUnique": false,
        "isCreateable": false,
        "isUpdateable": true,
        "isFilterable": true,
        "isCalculated": false,
        "javaType": "java.lang.String",
        "showLabel": true,
        "naturalOrder": 8,
        "linkedFields": [],
        "relatedInfos": [],
        "references": []
    }
]

Data Integration REST API

Download Guide

Watch

Comments

Cloud Data Integration Homepage