Package com.merge.api.resources.hris.fieldmapping

Class FieldMappingClient

java.lang.Object

com.merge.api.resources.hris.fieldmapping.FieldMappingClient

public class FieldMappingClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
FieldMappingClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
FieldMappingInstanceResponse	fieldMappingsCreate(CreateFieldMappingRequest request)	Create new Field Mappings that will be available after the next scheduled sync.
FieldMappingInstanceResponse	fieldMappingsCreate(CreateFieldMappingRequest request, RequestOptions requestOptions)	Create new Field Mappings that will be available after the next scheduled sync.
FieldMappingInstanceResponse	fieldMappingsDestroy(java.lang.String fieldMappingId)	Deletes Field Mappings for a Linked Account.
FieldMappingInstanceResponse	fieldMappingsDestroy(java.lang.String fieldMappingId, RequestOptions requestOptions)	Deletes Field Mappings for a Linked Account.
FieldMappingInstanceResponse	fieldMappingsPartialUpdate(java.lang.String fieldMappingId)	Create or update existing Field Mappings for a Linked Account.
FieldMappingInstanceResponse	fieldMappingsPartialUpdate(java.lang.String fieldMappingId, PatchedEditFieldMappingRequest request)	Create or update existing Field Mappings for a Linked Account.
FieldMappingInstanceResponse	fieldMappingsPartialUpdate(java.lang.String fieldMappingId, PatchedEditFieldMappingRequest request, RequestOptions requestOptions)	Create or update existing Field Mappings for a Linked Account.
FieldMappingApiInstanceResponse	fieldMappingsRetrieve()	Get all Field Mappings for this Linked Account.
FieldMappingApiInstanceResponse	fieldMappingsRetrieve(RequestOptions requestOptions)	Get all Field Mappings for this Linked Account.
RemoteFieldApiResponse	remoteFieldsRetrieve()	Get all remote fields for a Linked Account.
RemoteFieldApiResponse	remoteFieldsRetrieve(RemoteFieldsRetrieveRequest request)	Get all remote fields for a Linked Account.
RemoteFieldApiResponse	remoteFieldsRetrieve(RemoteFieldsRetrieveRequest request, RequestOptions requestOptions)	Get all remote fields for a Linked Account.
ExternalTargetFieldApiResponse	targetFieldsRetrieve()	Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields.
ExternalTargetFieldApiResponse	targetFieldsRetrieve(RequestOptions requestOptions)	Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

FieldMappingClient

public FieldMappingClient(ClientOptions clientOptions)

Method Detail

fieldMappingsRetrieve

public FieldMappingApiInstanceResponse fieldMappingsRetrieve()

Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. Learn more.

fieldMappingsRetrieve

public FieldMappingApiInstanceResponse fieldMappingsRetrieve(RequestOptions requestOptions)

Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. Learn more.

fieldMappingsCreate

public FieldMappingInstanceResponse fieldMappingsCreate(CreateFieldMappingRequest request)

Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsCreate

public FieldMappingInstanceResponse fieldMappingsCreate(CreateFieldMappingRequest request,
                                                        RequestOptions requestOptions)

Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsDestroy

public FieldMappingInstanceResponse fieldMappingsDestroy(java.lang.String fieldMappingId)

Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsDestroy

public FieldMappingInstanceResponse fieldMappingsDestroy(java.lang.String fieldMappingId,
                                                         RequestOptions requestOptions)

Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsPartialUpdate

public FieldMappingInstanceResponse fieldMappingsPartialUpdate(java.lang.String fieldMappingId)

Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsPartialUpdate

public FieldMappingInstanceResponse fieldMappingsPartialUpdate(java.lang.String fieldMappingId,
                                                               PatchedEditFieldMappingRequest request)

Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

fieldMappingsPartialUpdate

public FieldMappingInstanceResponse fieldMappingsPartialUpdate(java.lang.String fieldMappingId,
                                                               PatchedEditFieldMappingRequest request,
                                                               RequestOptions requestOptions)

Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync ALL data from start.

remoteFieldsRetrieve

public RemoteFieldApiResponse remoteFieldsRetrieve()

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. Learn more.

remoteFieldsRetrieve

public RemoteFieldApiResponse remoteFieldsRetrieve(RemoteFieldsRetrieveRequest request)

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. Learn more.

remoteFieldsRetrieve

public RemoteFieldApiResponse remoteFieldsRetrieve(RemoteFieldsRetrieveRequest request,
                                                   RequestOptions requestOptions)

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. Learn more.

targetFieldsRetrieve

public ExternalTargetFieldApiResponse targetFieldsRetrieve()

Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. Learn more.

targetFieldsRetrieve

public ExternalTargetFieldApiResponse targetFieldsRetrieve(RequestOptions requestOptions)

Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. Learn more.