Sync Rules

Subcategories: Sync Fields, Attachments, Notes

The sync rules resource is used to view, create, update, and delete the rule set containing field level filter criteria to restrict data downloaded to mobile devices.

Resource Plural Label

Sync Rules

Resource Name

__ORACO__SyncRule_c

Get All Sync Rules

Request: GET

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c

Request Path Parameters

There are no request path parameters for this task.

Request Query Parameters

Use these finder parameters to query the resource:

Finder Name Description

Primary Key

Finds a term with the specified primary key.

Finder Variables:
  • Id: The unique identifier of the sync rule.
    • Type: integer

Request Body

There are no elements in the request body for this task.

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Create a Sync Rule

Request: POST

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c

Request Path Parameters

There are no request path parameters for this task.

Request Body

This table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Replace a Sync Rule

Request: PUT

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c/{Id}

Request Path Parameters

This table summarizes the request path parameters:

Name Type Description

Id

integer

The unique identifier of the sync rule.

Request Body

This table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Get a Sync Rule

Request: GET

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c/{Id}

Request Path Parameters

This table summarizes the request path parameters:

Name Type Description

Id

integer

The unique identifier of the sync rule.

Request Body

There are no elements in the request body for this task.

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Update a Sync Rule

Request: PATCH

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c/{Id}

Request Path Parameters

This table summarizes the request path parameters:

Name Type Description

Id

integer

The unique identifier of the sync rule.

Request Body

This table summarizes the request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Delete a Sync Rule

Request: DELETE

URI: /crmRestApi/resources/11.13.18.05/__ORACO__SyncRule_c/{Id}

Request Path Parameters

This table summarizes the request path parameters:

Name Type Description

Id

integer

The unique identifier of the sync rule.

Request Body

There are no elements in the request body for this task.

Response Body

There are no elements in the response body for this task.

List of Values

This table lists all the list of values of the resource.

LOV Name Source Attribute in LOV Target Attribute in Resource

ViewAccessor_CurrencyCode

CurrencyCode

CurrencyCode

FK_LOVVA_For___ORACO__OraZcxOwner_c

ResourceProfileId

__ORACO__OraZcxOwner_Id_c

LOVVA_For___ORACO__OraZcxOwner_c

PartyName

__ORACO__OraZcxOwner_c

FK_LOVVA_For___ORACO__Object_c

Id

__ORACO__Object_Id_c

LOVVA_For___ORACO__Object_c

RecordName

__ORACO__Object_c

FK_LOVVA_For___ORACO__ParentObject_c

Id

__ORACO__ParentObject_Id_c

LOVVA_For___ORACO__ParentObject_c

RecordName

__ORACO__ParentObject_c

FK_LOVVA_For___ORACO__ParentSyncRule_c

Id

__ORACO__ParentSyncRule_Id_c

LOVVA_For___ORACO__ParentSyncRule_c

RecordName

__ORACO__ParentSyncRule_c

LOVVA_For___ORACO__Sync_c

value

__ORACO__Sync_c

LOVVA_For___ORACO__CriteriaGroupOperation_c

LookupCode

__ORACO__CriteriaGroupOperation_c

FK_LOVVA_For__ORACO__RefFieldFromParent_c

Id

__ORACO__RefFieldFromParent_Id_c

LOVVA_For__ORACO__RefFieldFromParent_c

RecordName

__ORACO__RefFieldFromParent_c

FK_LOVVA_For__ORACO__RefFieldFromObj_c

Id

__ORACO__RefFieldFromObj_Id_c

LOVVA_For__ORACO__RefFieldFromObj_c

RecordName

__ORACO__RefFieldFromObj_c

Resource Attributes

This table lists all the attributes of the resource.

Attribute Name Attribute Type Description

Id

number

The unique identifier of the sync rule.

UI Label:

Record ID

RecordName

string

The name of the sync rule.

Properties:

The maximum length is 80.

UI Label:

Rule Name

CreatedBy

string

The user who created the sync rule.

Properties:

The maximum length is 32.

UI Label:

Created By

CreationDate

datetime

The date when the sync rule was created.

UI Label:

Creation Date

LastUpdatedBy

string

The user who last updated the sync rule.

Properties:

The maximum length is 32.

UI Label:

Last Updated By

LastUpdateDate

datetime

The date when the sync rule was last updated.

UI Label:

Last Update Date

RecordNumber

string

The alternate key identifier of the sync rule.

Properties:

The maximum length is 64.

UI Label:

Record Number

LastUpdateLogin

string

The login of the user who last updated the sync rule .

Properties:

The maximum length is 32.

UserLastUpdateDate

datetime

The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (a different mobile database or the server).

CurrencyCode

string

The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.

Properties:

The maximum length is 15.

UI Label:

Currency Code

CurcyConvRateType

string

The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.

Properties:

The maximum length is 15.

CorpCurrencyCode

string

The corporate currency code associated with the sync rule. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

Properties:

The maximum length is 15.

__ORACO__OraZcxOwner_Id_c

number

The unique identifier of a resource associated with a sync rule.

UI Label:

Owner

__ORACO__OraZcxOwner_c

string

The name of a resource associated with a particular sync rule.

Properties:

The maximum length is 1500.

UI Label:

Owner

__ORACO__Object_Id_c

number

The unique identifier of the object for which the sync rule is created.

UI Label:

Object

__ORACO__Object_c

string

The name of the object for which the sync rule is created.

Properties:

The maximum length is 1500.

UI Label:

Object

__ORACO__ParentObject_Id_c

number

The unique identifier of the parent object for which the sync rule is created.

UI Label:

Parent Object

__ORACO__ParentObject_c

string

The name of the parent object for which the sync rule is created.

Properties:

The maximum length is 1500.

UI Label:

Parent Object

__ORACO__ParentSyncRule_Id_c

number

The unique identifier of the parent sync rule.

UI Label:

Parent Sync Rule

__ORACO__ParentSyncRule_c

string

The name of the parent sync rule.

Properties:

The maximum length is 1500.

UI Label:

Parent Sync Rule

__ORACO__Sync_c

boolean

Indicates whether the object need to be synced to mobile or not.

Properties:

The maximum length is 10.

UI Label:

Sync

__ORACO__CriteriaGroupOperation_c

string

The combination operation if there are more than one criteria group.

Properties:

The maximum length is 1500.

UI Label:

Criteria Group Operation

__ORACO__SelectedRow

string

A field used for internal logic.

UI Label:

SelectedRow

__ORACO__RefFieldFromParent_c

string

Reference id field from the parent object

UI Label

Reference field from Parent

__ORACO__RefFieldFromParent_Id_c

number

Id of Reference id field from the parent object

UI Label

Reference field from Parent

__ORACO__RefFieldFromObj_c

string

Reference id field from the object

UI Label

Reference field from Object

__ORACO__RefFieldFromObj_Id_c

number

Id of Reference id field from the object

UI Label

Reference field from Object

__ORACO__RuleForRetailTemplateApp_c

boolean

Rule created for Retail Template App

UI Label

Rule for Retail Template App