REST API Reference

Back Next

Getting field details

Use the fields resource to get field details for a source or target object.

GET request

To get field details for a source object, use one of the following URIs:

If you want to specify the source connection ID, use

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

If you want to specify the source connection name and the source object name, use

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

To get field details for a target object, use one of the following URIs:

If you want to specify the target connection ID, use

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

If you want to specify the target connection name and the target object name, use

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

You can use the following URI if the object name includes a forward slash (/):

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

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

The object name is case-sensitive.

GET response

The response returns the field object for each field in the source or target object and an error object if an error occurs.

The following table describes the attributes in the field object that might be returned based on the connection type:

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 field details for a Customer source object available through the source connection with 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.

Fields

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal