List Field Pipelines in an Entity
Gets all Field Pipelines In an Entity Pipeline
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Query Parameters
| Name | Type | Required | Notes |
| cursorToken | string |
Use the value from last response to get the next set of records |
|
| limit | integer |
Limit the number of the records to be returned |
Path Params
|
Name
|
Type
|
Required
|
|
pipelineId
Id of the pipeline to be replaced |
string
|
Example
Request Sample
curl --request GET --url https://api.syncari.com/api/v1/pipeline/1234/fieldPipelines \
--header 'Accept: application/json' \
--header 'Authorization: FTON46895FBIl' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: 123456789' \
--header 'syncariId: VBKIUF'
Response Sample
{
"success": true,
"requestId": "9571081918",
"timestamp": "2022-03-02T05:11:24.931386Z",
"cursorToken": "NjIxYzYzZmY3MmMwOGQwMDAxNDZmYmEx",
"result": [
{
"id": "621c63ff72c08d000146fba1",
"name": "Account",
"createdBy": null,
"createdAt": null,
"updatedBy": "61e7410057a5230001cf8fb2",
"updatedAt": "2022-02-28T05:56:15.779+00:00",
"entityId": "61dde49c3358d44665aec1e3",
"parentId": "62086e72adbccc00019373e9",
"scope": "ENTITY",
"lastSyncTime": null,
"syncStatus": null,
"draftStatus": "DRAFT",
"nodes": [
{
"id": "62086e72adbccc00019373ea",
"name": "Account",
"label": "Account",
"subLabel": "Syncari",
"configuration": {
"entityId": "61dde49c3358d44665aec1e3",
"synapseId": null,
"enableDeduplicate": false,
"dataAuthorityStrategy": "NONE"
},
"nodeType": "CORE_ENTITY",
"location": {
"x": "842",
"y": "399"
}
},
{
"id": "62189860d6d85d037a6c0e4f",
"name": " Customer",
"label": "Sync from Customer",
"subLabel": "Netsuite",
"configuration": {
"schedule": "* * * * * *",
"entityId": "621896e75ba2fe0001349b31",
"sourceParams": {},
"synapseId": "621896985ba2fe00013499e3",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "170",
"y": "442"
}
},
{
"id": "6218991cd6d85d037a6c1377",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Netsuite.customer.custentitydomain}}",
"type": "literal"
},
"predicateId": "6218996fd6d85d037a6c1561"
}
],
"groupPredicateId": "6218996fd6d85d037a6c1562",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "485",
"y": "442"
}
},
{
"id": "621899abd6d85d037a6c162a",
"name": " Account",
"label": "Sync from Account",
"subLabel": "Salesforce",
"configuration": {
"schedule": "",
"account_syncari_src_predicate": null,
"entityId": "61e7856a57a5230001cf93ef",
"sourceParams": {},
"synapseId": "61e74a5657a5230001cf91be",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "169",
"y": "309"
}
},
{
"id": "621899abd6d85d037a6c15fd",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Salesforce.Account.Website}}",
"type": "literal"
},
"predicateId": "621899f0d6d85d037a6c1969"
}
],
"groupPredicateId": "621899f0d6d85d037a6c196a",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "483",
"y": "309"
}
},
{
"id": "62189a6ed6d85d037a6c1976",
"name": "Only Referrals",
"label": "Only Referrals",
"subLabel": "",
"configuration": {
"predicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec20b",
"label": "Account Source (AccountSource)",
"type": "variable",
"datatype": "picklist",
"picklistGroup": "Account (syncari)"
},
"operator": "eq",
"right": {
"value": "Referrals 1 ",
"type": "literal"
},
"predicateId": "62189aeed6d85d037a6c1b13",
"name": "predicate"
}
],
"groupPredicateId": "62189aeed6d85d037a6c1b14",
"operator": "AND"
},
"functionId": "61dde49c3358d44665aec36a",
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "841",
"y": "495"
}
},
{
"id": "62189b3dd6d85d037a6c1b57",
"name": " Customer",
"label": "Sync to Customer",
"subLabel": "Netsuite",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "621896e75ba2fe0001349b31",
"synapseId": "621896985ba2fe00013499e3"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1217",
"y": "495"
}
},
{
"id": "62189b72d6d85d037a6c1cb9",
"name": " Account",
"label": "Sync to Account",
"subLabel": "Salesforce",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "61e7856a57a5230001cf93ef",
"synapseId": "61e74a5657a5230001cf91be"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1219",
"y": "397"
}
}
],
"edges": [
{
"id": "143c3b1d",
"source": {
"nodeId": "62189860d6d85d037a6c0e4f",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "6218991cd6d85d037a6c1377",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "7096b469",
"source": {
"nodeId": "6218991cd6d85d037a6c1377",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "62086e72adbccc00019373ea",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "f40c9ebc",
"source": {
"nodeId": "621899abd6d85d037a6c162a",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621899abd6d85d037a6c15fd",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "0f1ba5ea",
"source": {
"nodeId": "621899abd6d85d037a6c15fd",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "62086e72adbccc00019373ea",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "d40347f4",
"source": {
"nodeId": "62086e72adbccc00019373ea",
"datatype": "object",
"anchor": "2"
},
"destination": {
"nodeId": "62189a6ed6d85d037a6c1976",
"datatype": "object",
"anchor": "0"
}
},
{
"id": "e892037a",
"source": {
"nodeId": "62189a6ed6d85d037a6c1976",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "62189b3dd6d85d037a6c1b57",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "d8352a86",
"source": {
"nodeId": "62086e72adbccc00019373ea",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "62189b72d6d85d037a6c1cb9",
"datatype": "object",
"anchor": "3"
}
}
]
}
]
}
Get Field Pipeline By Id
Get details of a field pipeline by its id.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Path Parameters
| Name | Type | Required |
| pipelineId | string | |
| fieldPipelineId |
string |
Example
Request Sample
curl --request GET --url https://api.syncari.com/api/v1/pipeline/1234/fieldPipelines/2345 \
--header 'Accept: application/json' \
--header 'Authorization: FTON46895FBIl' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: 123456789' \
--header 'syncariId: VBKIUF'
Response Sample
{
"success": true,
"requestId": "2223102827",
"timestamp": "2022-03-02T06:20:49.166817Z",
"result": {
"id": "621f08139a5b1300015ade20",
"name": "Account Name",
"createdBy": "61e7410057a5230001cf8fb2",
"createdAt": "2022-03-02T06:00:51.479+00:00",
"updatedBy": "61e7410057a5230001cf8fb2",
"updatedAt": "2022-03-02T06:00:51.479+00:00",
"fieldId": "61dde49c3358d44665aec1ef",
"parentId": "62189c695ba2fe000134a575",
"scope": "FIELD",
"lastSyncTime": null,
"syncStatus": null,
"draftStatus": "DRAFT",
"nodes": [
{
"id": "621f08139a5b1300015ade23",
"name": "Account Name",
"label": "Sync to Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3",
"alwaysUseDefaultOnEmpty": false,
"defaultValue": ""
},
"nodeType": "ATTRIBUTE_SINK",
"location": {
"x": "900",
"y": "400"
}
},
{
"id": "621f08139a5b1300015ade21",
"name": "Account Name",
"label": "Sync from Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "400"
}
},
{
"id": "621f08139a5b1300015ade22",
"name": "Company Name",
"label": "Sync from Company Name",
"subLabel": "Netsuite Customer",
"configuration": {
"fieldId": "621896e75ba2fe0001349b49"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "250"
}
},
{
"id": "621f08139a5b1300015ade24",
"name": "Account Name",
"label": "Account Name",
"subLabel": "Syncari",
"configuration": {
"dataAuthority": {
"dataAuthorityStrategy": "NONE"
},
"fieldId": "61dde49c3358d44665aec1ef",
"rejectEmptyValue": true
},
"nodeType": "CORE_ATTRIBUTE",
"location": {
"x": "600",
"y": "400"
}
}
],
"edges": [
{
"id": "621f08139a5b1300015ade25",
"source": {
"nodeId": "621f08139a5b1300015ade21",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade26",
"source": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade23",
"datatype": "string",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade27",
"source": {
"nodeId": "621f08139a5b1300015ade22",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "3"
}
}
]
}
}
Create Field Pipeline
Creates a new field pipeline
When creating a new node, the id for nodes and nodeId for edges is required. Please start the id with "New nodeId: user-assigned-id". This id needs to correspond with the correct nodeId on edges. This user assigned id will be replaced with a Syncari id.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Body (application/json)
| Name | Type | Required | Notes |
| name | string | ||
| fieldId | string | ||
|
nodes id name label sublabel configuration entityId synapseId enableDeduplicate dataAuthorityStrategy nodeType location edges source nodeId datatype anchor destination nodeId datatype anchor |
array[object] string string string string object string string boolean string string object array[object] object string string string object string string string |
|
label is used to set the label for function and action nodes
sublabel is used to set the subLabel for function and action nodes
anchor relates to the arrows connecting nodes in UI. The numbering goes from 0 to 3 with 0 corresponding to the top of the node and the numbers moving clockwise. |
Example
Request Sample
curl --request POST \
--url https://api.syncari.com/api/v1/pipelines/pipeline/fieldPipelines \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--header 'clientRequestId: ' \
--header 'syncariId: ' \
--data '{
"fieldId": "61dde49c3358d44665aec1ef",
"nodes": [
{
"id": "New nodeId: 1",
"name": "Account Name",
"label": "Sync to Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3",
"alwaysUseDefaultOnEmpty": false,
"defaultValue": ""
},
"nodeType": "ATTRIBUTE_SINK",
"location": {
"x": "900",
"y": "400"
}
},
{
"id": "New nodeId: 2",
"name": "Account Name",
"label": "Sync from Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "400"
}
},
{
"id": "New nodeId: 3",
"name": "Company Name",
"label": "Sync from Company Name",
"subLabel": "Netsuite Customer",
"configuration": {
"fieldId": "621896e75ba2fe0001349b49"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "250"
}
},
{
"id": "New nodeId: 4",
"name": "Account Name",
"label": "Account Name",
"subLabel": "Syncari",
"configuration": {
"dataAuthority": {
"dataAuthorityStrategy": "NONE"
},
"fieldId": "61dde49c3358d44665aec1ef",
"rejectEmptyValue": true
},
"nodeType": "CORE_ATTRIBUTE",
"location": {
"x": "600",
"y": "400"
}
}
],
"edges": [
{
"source": {
"nodeId": "New nodeId: 2",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "New nodeId: 4",
"datatype": "string",
"anchor": "3"
}
},
{
"source": {
"nodeId": "New nodeId: 4",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "New nodeId: 1",
"datatype": "string",
"anchor": "3"
}
},
{
"source": {
"nodeId": "New nodeId: 3",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "New nodeId: 4",
"datatype": "string",
"anchor": "3"
}
}
]
}'
Response Sample
{
"success": true,
"requestId": "2223102827",
"timestamp": "2022-03-02T06:20:49.166817Z",
"result": {
"id": "621f08139a5b1300015ade20",
"name": "Account Name",
"createdBy": "61e7410057a5230001cf8fb2",
"createdAt": "2022-03-02T06:00:51.479+00:00",
"updatedBy": "61e7410057a5230001cf8fb2",
"updatedAt": "2022-03-02T06:00:51.479+00:00",
"fieldId": "61dde49c3358d44665aec1ef",
"parentId": "62189c695ba2fe000134a575",
"scope": "FIELD",
"lastSyncTime": null,
"syncStatus": null,
"draftStatus": "DRAFT",
"nodes": [
{
"id": "621f08139a5b1300015ade23",
"name": "Account Name",
"label": "Sync to Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3",
"alwaysUseDefaultOnEmpty": false,
"defaultValue": ""
},
"nodeType": "ATTRIBUTE_SINK",
"location": {
"x": "900",
"y": "400"
}
},
{
"id": "621f08139a5b1300015ade21",
"name": "Account Name",
"label": "Sync from Account Name",
"subLabel": "Salesforce Account",
"configuration": {
"fieldId": "61e7856a57a5230001cf93f3"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "400"
}
},
{
"id": "621f08139a5b1300015ade22",
"name": "Company Name",
"label": "Sync from Company Name",
"subLabel": "Netsuite Customer",
"configuration": {
"fieldId": "621896e75ba2fe0001349b49"
},
"nodeType": "ATTRIBUTE_SOURCE",
"location": {
"x": "300",
"y": "250"
}
},
{
"id": "621f08139a5b1300015ade24",
"name": "Account Name",
"label": "Account Name",
"subLabel": "Syncari",
"configuration": {
"dataAuthority": {
"dataAuthorityStrategy": "NONE"
},
"fieldId": "61dde49c3358d44665aec1ef",
"rejectEmptyValue": true
},
"nodeType": "CORE_ATTRIBUTE",
"location": {
"x": "600",
"y": "400"
}
}
],
"edges": [
{
"id": "621f08139a5b1300015ade25",
"source": {
"nodeId": "621f08139a5b1300015ade21",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade26",
"source": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade23",
"datatype": "string",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade27",
"source": {
"nodeId": "621f08139a5b1300015ade22",
"datatype": "string",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade24",
"datatype": "string",
"anchor": "3"
}
}
]
}
}
Replace Field Pipeline
Replaces an existing pipeline with the incoming pipeline. Valid only on draft pipelines
When adding a new node, the id for nodes and nodeId for edges is required. Please start the id with "New nodeId: user-assigned-id". This id needs to correspond with the correct nodeId on edges. This user assigned id will be replaced with a Syncari id.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Path Params
|
Name
|
Type
|
Required
|
|
pipelineId
Id of the entity pipeline |
string
|
|
| fieldPipelineId
Id of the field pipeline to be replaced
|
string
|
Body (application/json)
| Name | Type | Required | Notes |
| name | string | ||
| entityId | string | ||
|
nodes id name label sublabel configuration entityId synapseId enableDeduplicate dataAuthorityStrategy nodeType location edges source nodeId datatype anchor destination nodeId datatype anchor |
array[object] string string string string object string string boolean string string object array[object] object string string string object string string string |
|
label is used to set the label for function and action nodes
sublabel is used to set the subLabel for function and action nodes
anchor relates to the arrows connecting nodes in UI. The numbering goes from 0 to 3 with 0 corresponding to the top of the node and the numbers moving clockwise. |
Example
Request Sample
curl --request PUT \
--url https://api.syncari.com/api/v1/pipelines/pipelineId \
--header 'Accept: application/json' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--header 'syncariId: ' \
--data '{
"nodes": [
{
"id": "621f08139a5b1300015ade4a",
"name": "Only Referrals",
"label": "Only Referrals",
"subLabel": "",
"configuration": {
"predicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec20b",
"label": "Account Source (AccountSource)",
"type": "variable",
"datatype": "picklist",
"picklistGroup": "Account (syncari)"
},
"operator": "eq",
"right": {
"value": "Referrals 1 ",
"type": "literal"
},
"predicateId": "62189aeed6d85d037a6c1b13",
"name": "predicate"
}
],
"groupPredicateId": "62189aeed6d85d037a6c1b14",
"operator": "AND"
},
"functionId": "61dde49c3358d44665aec36a",
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "841",
"y": "495"
}
},
{
"id": "621f08139a5b1300015ade45",
"name": "Account",
"label": "Account",
"subLabel": "Syncari",
"configuration": {
"entityId": "61dde49c3358d44665aec1e3",
"synapseId": null,
"enableDeduplicate": false,
"dataAuthorityStrategy": "NONE"
},
"nodeType": "CORE_ENTITY",
"location": {
"x": "842",
"y": "399"
}
},
{
"id": "621f08139a5b1300015ade49",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Salesforce.Account.Website}}",
"type": "literal"
},
"predicateId": "621899f0d6d85d037a6c1969"
}
],
"groupPredicateId": "621899f0d6d85d037a6c196a",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "483",
"y": "309"
}
},
{
"id": "621f08139a5b1300015ade47",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Netsuite.customer.custentitydomain}}",
"type": "literal"
},
"predicateId": "6218996fd6d85d037a6c1561"
}
],
"groupPredicateId": "6218996fd6d85d037a6c1562",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "485",
"y": "442"
}
},
{
"id": "621f08139a5b1300015ade48",
"name": " Account",
"label": "Sync from Account",
"subLabel": "Salesforce",
"configuration": {
"schedule": "",
"account_syncari_src_predicate": null,
"entityId": "61e7856a57a5230001cf93ef",
"sourceParams": {},
"synapseId": "61e74a5657a5230001cf91be",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "169",
"y": "309"
}
},
{
"id": "621f08139a5b1300015ade4c",
"name": " Account",
"label": "Sync to Account",
"subLabel": "Salesforce",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "61e7856a57a5230001cf93ef",
"synapseId": "61e74a5657a5230001cf91be"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1219",
"y": "397"
}
},
{
"id": "621f08139a5b1300015ade46",
"name": " Customer",
"label": "Sync from Customer",
"subLabel": "Netsuite",
"configuration": {
"schedule": "* * * * * *",
"entityId": "621896e75ba2fe0001349b31",
"sourceParams": {},
"synapseId": "621896985ba2fe00013499e3",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "170",
"y": "442"
}
},
{
"id": "621f08139a5b1300015ade4b",
"name": " Customer",
"label": "Sync to Customer",
"subLabel": "Netsuite",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "621896e75ba2fe0001349b31",
"synapseId": "621896985ba2fe00013499e3"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1217",
"y": "495"
}
}
],
"edges": [
{
"id": "621f08139a5b1300015ade4d",
"source": {
"nodeId": "621f08139a5b1300015ade46",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade47",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade4e",
"source": {
"nodeId": "621f08139a5b1300015ade47",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade4f",
"source": {
"nodeId": "621f08139a5b1300015ade48",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade49",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade50",
"source": {
"nodeId": "621f08139a5b1300015ade49",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade51",
"source": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "2"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4a",
"datatype": "object",
"anchor": "0"
}
},
{
"id": "621f08139a5b1300015ade52",
"source": {
"nodeId": "621f08139a5b1300015ade4a",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4b",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade53",
"source": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4c",
"datatype": "object",
"anchor": "3"
}
}
]
}'
Response Sample
{
"success": true,
"requestId": "4297410641",
"timestamp": "2022-03-02T06:01:15.137909Z",
"result": {
"id": "621f08139a5b1300015ade44",
"name": "Account",
"createdBy": "61e7410057a5230001cf8fb2",
"createdAt": "2022-03-02T06:00:51.756+00:00",
"updatedBy": "61e7410057a5230001cf8fb2",
"updatedAt": "2022-03-02T06:00:51.756+00:00",
"entityId": "61dde49c3358d44665aec1e3",
"parentId": "62086e72adbccc00019373e9",
"scope": "ENTITY",
"lastSyncTime": null,
"syncStatus": null,
"draftStatus": "DRAFT",
"nodes": [
{
"id": "621f08139a5b1300015ade4a",
"name": "Only Referrals",
"label": "Only Referrals",
"subLabel": "",
"configuration": {
"predicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec20b",
"label": "Account Source (AccountSource)",
"type": "variable",
"datatype": "picklist",
"picklistGroup": "Account (syncari)"
},
"operator": "eq",
"right": {
"value": "Referrals 1 ",
"type": "literal"
},
"predicateId": "62189aeed6d85d037a6c1b13",
"name": "predicate"
}
],
"groupPredicateId": "62189aeed6d85d037a6c1b14",
"operator": "AND"
},
"functionId": "61dde49c3358d44665aec36a",
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "841",
"y": "495"
}
},
{
"id": "621f08139a5b1300015ade45",
"name": "Account",
"label": "Account",
"subLabel": "Syncari",
"configuration": {
"entityId": "61dde49c3358d44665aec1e3",
"synapseId": null,
"enableDeduplicate": false,
"dataAuthorityStrategy": "NONE"
},
"nodeType": "CORE_ENTITY",
"location": {
"x": "842",
"y": "399"
}
},
{
"id": "621f08139a5b1300015ade49",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Salesforce.Account.Website}}",
"type": "literal"
},
"predicateId": "621899f0d6d85d037a6c1969"
}
],
"groupPredicateId": "621899f0d6d85d037a6c196a",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "483",
"y": "309"
}
},
{
"id": "621f08139a5b1300015ade47",
"name": "Attach Record",
"label": "Attach Record",
"subLabel": "",
"configuration": {
"functionId": "61dde4a03358d44665aec45c",
"attachPredicate": {
"predicates": [
{
"left": {
"value": "61dde49c3358d44665aec212",
"label": "Syncari: Domain",
"type": "variable",
"datatype": "string",
"picklistGroup": "Existing Record"
},
"operator": "eq",
"right": {
"value": "{{Netsuite.customer.custentitydomain}}",
"type": "literal"
},
"predicateId": "6218996fd6d85d037a6c1561"
}
],
"groupPredicateId": "6218996fd6d85d037a6c1562",
"operator": "AND"
},
"graphVersion": "NEW",
"description": "",
"value": ""
},
"nodeType": "FUNCTION",
"location": {
"x": "485",
"y": "442"
}
},
{
"id": "621f08139a5b1300015ade48",
"name": " Account",
"label": "Sync from Account",
"subLabel": "Salesforce",
"configuration": {
"schedule": "",
"account_syncari_src_predicate": null,
"entityId": "61e7856a57a5230001cf93ef",
"sourceParams": {},
"synapseId": "61e74a5657a5230001cf91be",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "169",
"y": "309"
}
},
{
"id": "621f08139a5b1300015ade4c",
"name": " Account",
"label": "Sync to Account",
"subLabel": "Salesforce",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "61e7856a57a5230001cf93ef",
"synapseId": "61e74a5657a5230001cf91be"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1219",
"y": "397"
}
},
{
"id": "621f08139a5b1300015ade46",
"name": " Customer",
"label": "Sync from Customer",
"subLabel": "Netsuite",
"configuration": {
"schedule": "* * * * * *",
"entityId": "621896e75ba2fe0001349b31",
"sourceParams": {},
"synapseId": "621896985ba2fe00013499e3",
"destinationParams": {}
},
"nodeType": "ENTITY_SOURCE",
"location": {
"x": "170",
"y": "442"
}
},
{
"id": "621f08139a5b1300015ade4b",
"name": " Customer",
"label": "Sync to Customer",
"subLabel": "Netsuite",
"configuration": {
"acceptsDeletesFrom": [],
"entityId": "621896e75ba2fe0001349b31",
"synapseId": "621896985ba2fe00013499e3"
},
"nodeType": "ENTITY_SINK",
"location": {
"x": "1217",
"y": "495"
}
}
],
"edges": [
{
"id": "621f08139a5b1300015ade4d",
"source": {
"nodeId": "621f08139a5b1300015ade46",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade47",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade4e",
"source": {
"nodeId": "621f08139a5b1300015ade47",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade4f",
"source": {
"nodeId": "621f08139a5b1300015ade48",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade49",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade50",
"source": {
"nodeId": "621f08139a5b1300015ade49",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade51",
"source": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "2"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4a",
"datatype": "object",
"anchor": "0"
}
},
{
"id": "621f08139a5b1300015ade52",
"source": {
"nodeId": "621f08139a5b1300015ade4a",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4b",
"datatype": "object",
"anchor": "3"
}
},
{
"id": "621f08139a5b1300015ade53",
"source": {
"nodeId": "621f08139a5b1300015ade45",
"datatype": "object",
"anchor": "1"
},
"destination": {
"nodeId": "621f08139a5b1300015ade4c",
"datatype": "object",
"anchor": "3"
}
}
]
}
}
Delete Field Pipeline
Deletes a field pipeline.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Path Params
|
Name
|
Type
|
Required
|
|
pipelineId
Id of the entity pipeline |
string
|
|
| fieldPipelineId
Id of the field pipeline to be replaced
|
string
|
Example
Request Sample
curl --request DELETE \ --url https://api.syncari.com/api/v1/pipelines/123/fieldPipelines/234 \ --header 'Accept: application/json' \ --header 'Authorization: ' \ --header 'clientRequestId: ' \ --header 'syncariId: '
Response Sample
{
"success": true,
"requestId": "5952036550",
"timestamp": "2022-03-11T00:45:19.608764Z",
"result": {
"deleteCount": 1
}
}
Validate Field Pipeline
Validates a given field pipeline. API will return 409 for conflicts with a list of error messages.
Request
Headers
|
Name
|
Type
|
Required
|
|
syncariId
Id of the instance the API is to be run against |
string
|
|
|
clientRequestId
Client side request id to be used for idempotency in the future
|
string
|
|
Path Params
|
Name
|
Type
|
Required
|
|
pipelineId
Id of the entity pipeline |
string
|
|
| fieldPipelineId
Id of the field pipeline to be replaced
|
string
|
Example
Request Sample
curl --request POST \ --url https://api.syncari.com/api/v1/pipelines/234/fieldPipelines/345/validate \ --header 'Accept: application/json' \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --header 'clientRequestId: ' \ --header 'syncariId: '
Response Sample
{
"success": true,
"requestId": "1234abcd",
"timestamp": "2022-02-04T06:13:43.734597Z",
"result": {
"id": "5ee40b5107b11100015557de",
"validationStatus": "success"
}
}