Schema

Varsha Neelesh
Varsha Neelesh
  • Updated

List Entities for a Synapse

Lists all approved entity schema for a synapse.

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
required-table (1).svg

Query Parameters

Name Type Required Notes
cursorToken string  

Provided to get the next set of records for cursor pagination

limit number  

Limit the number of records returned.

Default: 100
synapseId string required-table (1).svg

The unique id of the synapse to get the entities for.

includeFields string  

Return fields under an entity

Allowed values:
true|false
Default: false
status string  

Filter based on entity status (approved/draft)

Allowed values:
approved|draft
Default: approved

Request Sample

curl --request GET --url https://api.syncari.com/api/v1/entitiies \
    --header 'Accept: application/json' \
    --header 'Authorization: FTON46895FBIl' \
    --header 'Content-Type: application/json' \
    --header 'clientRequestId: 123456789' \
    --header 'syncariId: VBKIUF'

Response Sample

{
  "success": true,
  "requestId": "7966591995",
  "timestamp": "2022-02-04T03:43:20.986337Z",
  "cursorToken": "NjFlNzk5MTY0ZjA0MzA1NThkYzYxMGRh",
  "result": [
    {
      "id": "61e799164f0430558dc610da",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:38.041+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:38.041+00:00",
      "synapseId": "61e798e54f0430558dc60e03",
      "apiName": "AssignmentRule",
      "status": "ACTIVE",
      "datastoreName": "AssignmentRule",
      "displayName": "Assignment Rule",
      "description": null,
      "type": "standard",
      "tags": [],
      "fields": [
        {
          "id": "61e799164f0430558dc610de",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Active",
          "status": "ACTIVE",
          "datastoreName": "Active",
          "displayName": "Active",
          "description": null,
          "compositeKey": null,
          "dataType": "boolean",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610df",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "CreatedById",
          "status": "ACTIVE",
          "datastoreName": "CreatedById",
          "displayName": "Created By ID",
          "description": null,
          "compositeKey": null,
          "dataType": "reference",
          "parentAttributeId": null,
          "referenceTargetField": "Id",
          "referenceTo": "User",
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e0",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "CreatedDate",
          "status": "ACTIVE",
          "datastoreName": "CreatedDate",
          "displayName": "Created Date",
          "description": null,
          "compositeKey": null,
          "dataType": "datetime",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610db",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Id",
          "status": "ACTIVE",
          "datastoreName": "Id",
          "displayName": "Rule ID",
          "description": null,
          "compositeKey": null,
          "dataType": "id",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": true,
          "multiValueField": false,
          "readOnly": true,
          "required": true,
          "syncariDefined": false,
          "system": true,
          "unique": true,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e1",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "LastModifiedById",
          "status": "ACTIVE",
          "datastoreName": "LastModifiedById",
          "displayName": "Last Modified By ID",
          "description": null,
          "compositeKey": null,
          "dataType": "reference",
          "parentAttributeId": null,
          "referenceTargetField": "Id",
          "referenceTo": "User",
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e2",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "LastModifiedDate",
          "status": "ACTIVE",
          "datastoreName": "LastModifiedDate",
          "displayName": "Last Modified Date",
          "description": null,
          "compositeKey": null,
          "dataType": "datetime",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610dc",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Name",
          "status": "ACTIVE",
          "datastoreName": "Name",
          "displayName": "Name",
          "description": null,
          "compositeKey": null,
          "dataType": "string",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 120,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610dd",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "SobjectType",
          "status": "ACTIVE",
          "datastoreName": "SobjectType",
          "displayName": "SObject Type",
          "description": null,
          "compositeKey": null,
          "dataType": "picklist",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 40,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [
            "Case",
            "Lead"
          ],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e3",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "SystemModstamp",
          "status": "ACTIVE",
          "datastoreName": "SystemModstamp",
          "displayName": "System Modstamp",
          "description": null,
          "compositeKey": null,
          "dataType": "datetime",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": true,
          "picklistValues": [],
          "tags": [],
          "draft": false
        }
      ],
      "draft": false,
      "readOnly": false
    }
  ]
}
}

Example


Get Entity by ID

Get the entity details for a specific entityId.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Query Parameters

Name Type Required Notes
includeFields string  

Return fields under an entity

Allowed values:
true|false
Default: false

 

Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/entities/entityId \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'syncariId: '

 

Response Sample

{
  "success": true,
  "requestId": "7966591995",
  "timestamp": "2022-02-04T03:43:20.986337Z",
  "cursorToken": "NjFlNzk5MTY0ZjA0MzA1NThkYzYxMGRh",
  "result": 
    {
      "id": "61e799164f0430558dc610da",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:38.041+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:38.041+00:00",
      "synapseId": "61e798e54f0430558dc60e03",
      "apiName": "AssignmentRule",
      "status": "ACTIVE",
      "datastoreName": "AssignmentRule",
      "displayName": "Assignment Rule",
      "description": null,
      "type": "standard",
      "tags": [],
      "fields": [
        {
          "id": "61e799164f0430558dc610de",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Active",
          "status": "ACTIVE",
          "datastoreName": "Active",
          "displayName": "Active",
          "description": null,
          "compositeKey": null,
          "dataType": "boolean",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610df",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "CreatedById",
          "status": "ACTIVE",
          "datastoreName": "CreatedById",
          "displayName": "Created By ID",
          "description": null,
          "compositeKey": null,
          "dataType": "reference",
          "parentAttributeId": null,
          "referenceTargetField": "Id",
          "referenceTo": "User",
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e0",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "CreatedDate",
          "status": "ACTIVE",
          "datastoreName": "CreatedDate",
          "displayName": "Created Date",
          "description": null,
          "compositeKey": null,
          "dataType": "datetime",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610db",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Id",
          "status": "ACTIVE",
          "datastoreName": "Id",
          "displayName": "Rule ID",
          "description": null,
          "compositeKey": null,
          "dataType": "id",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": true,
          "multiValueField": false,
          "readOnly": true,
          "required": true,
          "syncariDefined": false,
          "system": true,
          "unique": true,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e1",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "LastModifiedById",
          "status": "ACTIVE",
          "datastoreName": "LastModifiedById",
          "displayName": "Last Modified By ID",
          "description": null,
          "compositeKey": null,
          "dataType": "reference",
          "parentAttributeId": null,
          "referenceTargetField": "Id",
          "referenceTo": "User",
          "length": 18,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610e2",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.054+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.054+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "LastModifiedDate",
          "status": "ACTIVE",
          "datastoreName": "LastModifiedDate",
          "displayName": "Last Modified Date",
          "description": null,
          "compositeKey": null,
          "dataType": "datetime",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 0,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": true,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610dc",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "Name",
          "status": "ACTIVE",
          "datastoreName": "Name",
          "displayName": "Name",
          "description": null,
          "compositeKey": null,
          "dataType": "string",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 120,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [],
          "tags": [],
          "draft": false
        },
        {
          "id": "61e799164f0430558dc610dd",
          "createdBy": "61e2a1e234a0f06966a1995e",
          "createdAt": "2022-01-19T04:52:38.053+00:00",
          "updatedBy": "61e2a1e234a0f06966a1995e",
          "updatedAt": "2022-01-19T04:52:38.053+00:00",
          "entityId": "61e799164f0430558dc610da",
          "apiName": "SobjectType",
          "status": "ACTIVE",
          "datastoreName": "SobjectType",
          "displayName": "SObject Type",
          "description": null,
          "compositeKey": null,
          "dataType": "picklist",
          "parentAttributeId": null,
          "referenceTargetField": null,
          "referenceTo": null,
          "length": 40,
          "precision": 0,
          "custom": false,
          "calculated": false,
          "createOnly": false,
          "idField": false,
          "multiValueField": false,
          "readOnly": true,
          "required": false,
          "syncariDefined": false,
          "system": false,
          "unique": false,
          "watermarkField": false,
          "picklistValues": [
            "Case",
            "Lead"
          ],
          "tags": [],
          "draft": false
        }
    }
}



List Fields for a Synapse Entity

Retrieves all field information for an entity of a synapse.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Query Parameters

Name Type Required Notes
limit number  

Limit the number of records returned.

Default: 100

Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/entities/entityId/fields \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'syncariId: '

 

Response Sample

{
  "success": true,
  "requestId": "1088900098",
  "timestamp": "2022-02-04T02:57:36.746757Z",
  "result": [
    {
      "id": "61e799154f0430558dc60eb3",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "AccountId",
      "status": "ACTIVE",
      "datastoreName": "AccountId",
      "displayName": "Account ID",
      "description": null,
      "compositeKey": null,
      "dataType": "reference",
      "parentAttributeId": null,
      "referenceTargetField": "Id",
      "referenceTo": "Account",
      "length": 18,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": true,
      "syncariDefined": false,
      "system": false,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb4",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "CreatedById",
      "status": "ACTIVE",
      "datastoreName": "CreatedById",
      "displayName": "Created By ID",
      "description": null,
      "compositeKey": null,
      "dataType": "reference",
      "parentAttributeId": null,
      "referenceTargetField": "Id",
      "referenceTo": "User",
      "length": 18,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": false,
      "syncariDefined": false,
      "system": true,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb5",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "CreatedDate",
      "status": "ACTIVE",
      "datastoreName": "CreatedDate",
      "displayName": "Created Date",
      "description": null,
      "compositeKey": null,
      "dataType": "datetime",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 0,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": false,
      "syncariDefined": false,
      "system": true,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb6",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "Field",
      "status": "ACTIVE",
      "datastoreName": "Field",
      "displayName": "Changed Field",
      "description": null,
      "compositeKey": null,
      "dataType": "picklist",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 255,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": true,
      "syncariDefined": false,
      "system": false,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [
        "accountMerged",
        "Name",
        "TextName",
        "AccountNumber",
        "Owner",
        "Site",
        "AccountSource",
        "AnnualRevenue",
        "BillingAddress",
        "BillingCity",
        "BillingCountry",
        "BillingGeocodeAccuracy",
        "BillingLatitude",
        "BillingLongitude",
        "BillingState",
        "BillingStreet",
        "BillingPostalCode",
        "created",
        "accountCreatedFromLead",
        "DanTest__c",
        "DanTest2__c",
        "Jigsaw",
        "Description",
        "NumberOfEmployees",
        "Fax",
        "feedEvent",
        "individualMerged",
        "Industry",
        "accountUpdatedByLead",
        "personAccountUpdatedByLead",
        "ownerAccepted",
        "ownerAssignment",
        "Ownership",
        "Parent",
        "Phone",
        "Rating",
        "locked",
        "unlocked",
        "ShippingAddress",
        "ShippingCity",
        "ShippingCountry",
        "ShippingGeocodeAccuracy",
        "ShippingLatitude",
        "ShippingLongitude",
        "ShippingState",
        "ShippingStreet",
        "ShippingPostalCode",
        "Sic",
        "SicDesc",
        "TickerSymbol",
        "Type",
        "Website"
      ],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb1",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.639+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.639+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "Id",
      "status": "ACTIVE",
      "datastoreName": "Id",
      "displayName": "Account History ID",
      "description": null,
      "compositeKey": null,
      "dataType": "id",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 18,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": true,
      "multiValueField": false,
      "readOnly": true,
      "required": true,
      "syncariDefined": false,
      "system": true,
      "unique": true,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb2",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "IsDeleted",
      "status": "ACTIVE",
      "datastoreName": "IsDeleted",
      "displayName": "Deleted",
      "description": null,
      "compositeKey": null,
      "dataType": "boolean",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 0,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": false,
      "syncariDefined": false,
      "system": true,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb8",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "NewValue",
      "status": "ACTIVE",
      "datastoreName": "NewValue",
      "displayName": "New Value",
      "description": null,
      "compositeKey": null,
      "dataType": "string",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 255,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": false,
      "syncariDefined": false,
      "system": false,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    },
    {
      "id": "61e799154f0430558dc60eb7",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "OldValue",
      "status": "ACTIVE",
      "datastoreName": "OldValue",
      "displayName": "Old Value",
      "description": null,
      "compositeKey": null,
      "dataType": "string",
      "parentAttributeId": null,
      "referenceTargetField": null,
      "referenceTo": null,
      "length": 255,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": false,
      "syncariDefined": false,
      "system": false,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    }
  ]
}



Get Field by ID

Gets the field details for a specific fieldId.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId
Unique ID oof entity
string
required-table (1).svg
fieldId

Unique ID of the field

string
required-table (1).svg

 

Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/entities/entityId/fields/fieldId \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'syncariId: '

 

Response Sample

{
  "success": true,
  "requestId": "1088900098",
  "timestamp": "2022-02-04T02:57:36.746757Z",
  "result": 
    {
      "id": "61e799154f0430558dc60eb3",
      "createdBy": "61e2a1e234a0f06966a1995e",
      "createdAt": "2022-01-19T04:52:37.641+00:00",
      "updatedBy": "61e2a1e234a0f06966a1995e",
      "updatedAt": "2022-01-19T04:52:37.641+00:00",
      "entityId": "61e799154f0430558dc60eb0",
      "apiName": "AccountId",
      "status": "ACTIVE",
      "datastoreName": "AccountId",
      "displayName": "Account ID",
      "description": null,
      "compositeKey": null,
      "dataType": "reference",
      "parentAttributeId": null,
      "referenceTargetField": "Id",
      "referenceTo": "Account",
      "length": 18,
      "precision": 0,
      "custom": false,
      "calculated": false,
      "createOnly": false,
      "idField": false,
      "multiValueField": false,
      "readOnly": true,
      "required": true,
      "syncariDefined": false,
      "system": false,
      "unique": false,
      "watermarkField": false,
      "picklistValues": [],
      "tags": [],
      "draft": false
    }
  }
}



Create Draft Entity

Creates a draft entity off a published entity. Supported on for Syncari, Marketo, Amazon DynamoDB, and PostgreSQL Synapses.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/entities/entityId/createDraft \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: '

 

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "string",
  "result": {
    "id": "string",
    "createdBy": "string",
    "createdAt": "string",
    "updatedBy": "string",
    "updatedAt": "string",
    "synapseId": "string",
    "apiName": "string",
    "status": "string",
    "datastoreName": "string",
    "displayName": "string",
    "description": null,
    "type": "string",
    "tags": [
      {}
    ],
    "fields": [
      {
        "id": "string",
        "createdBy": "string",
        "createdAt": "string",
        "updatedBy": "string",
        "updatedAt": "string",
        "entityId": "string",
        "apiName": "string",
        "status": "string",
        "datastoreName": "string",
        "displayName": "string",
        "description": null,
        "compositeKey": null,
        "dataType": "string",
        "parentAttributeId": null,
        "referenceTargetField": "string",
        "referenceTo": "string",
        "length": 0,
        "precision": 0,
        "custom": true,
        "calculated": true,
        "createOnly": true,
        "idField": true,
        "multiValueField": true,
        "readOnly": true,
        "required": true,
        "syncariDefined": true,
        "system": true,
        "unique": true,
        "watermarkField": true,
        "picklistValues": [
          {}
        ],
        "tags": [
          {}
        ],
        "draft": true
      }
    ],
    "draft": true,
    "readOnly": true
  }
}



Publish Draft Entity

Publishes a draft entity. Supported on for Syncari, Marketo, Amazon DynamoDB, and PostgreSQL Synapses.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/entities/entityId/publish \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: '

 

Response Sample

{
  "id": "string"
}



Delete Draft Entity

Deletes a draft entity. Supported on for Syncari, Marketo, Amazon DynamoDB, and PostgreSQL Synapses.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Example

Request Sample

curl --request DELETE \
  --url https://api.syncari.com/api/v1/entities/entityId \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'clientRequestId: ' \
  --header 'syncariId: '

 

Response Sample

{
  "id": "string"
}



Create Field

Creates a new field on a draft entity. Supported on for Syncari, Marketo, Amazon DynamoDB, and PostgreSQL Synapses.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/entities/entityId/fields \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: ' \
  --data '{
  "apiName": "apiName",
  "displayName": "displayName",
  "datastoreName": "datastoreName",
  "description": "description",
  "dataType": "String",
  "length": 50,
  "multiValueField": false,
  "required": true,
  "unique": true,
  "picklistValues": [],
  "tags": [
    "Tag1",
    "Tag2"
  ]
}'

 

Response Sample

{
  "success": true,
  "requestId": "6428160052",
  "timestamp": "2022-02-04T02:53:40.961313Z",
  "result": {
    "id": "61f88ac79dcaf01a0f25766d",
    "createdBy": "61e2a0f134a0f06932046bab",
    "createdAt": "2022-02-01T01:20:07.982+00:00",
    "updatedBy": "61e2a0f134a0f06932046bab",
    "updatedAt": "2022-02-01T01:20:07.982+00:00",
    "entityId": "61f88ac79dcaf01a0f257643",
    "apiName": "Type",
    "status": "ACTIVE",
    "datastoreName": "Type",
    "displayName": "Account Type",
    "description": null,
    "compositeKey": null,
    "dataType": "picklist",
    "parentAttributeId": null,
    "referenceTargetField": null,
    "referenceTo": null,
    "length": 40,
    "precision": 0,
    "custom": false,
    "calculated": false,
    "createOnly": false,
    "idField": false,
    "multiValueField": false,
    "readOnly": false,
    "required": false,
    "syncariDefined": false,
    "system": false,
    "unique": false,
    "watermarkField": false,
    "picklistValues": [
      "Analyst",
      "Competitor",
      "Customer",
      "Integrator",
      "Investor",
      "Partner",
      "Press",
      "Prospect",
      "Reseller",
      "Other"
    ],
    "tags": [],
    "draft": true
  }
}

 


Update Field (Batch)

Batch update for Syncari fields. The API takes in an array of update request and synchronously updates all fields in the request. If any of the supplied fields fails validation, the entire request will be treated as a bad request and no fields will be updated. The response will have a list of field ids for successful updates and failed updates.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg

 

Example

Request Sample

curl --request PATCH \
  --url https://api.syncari.com/api/v1/entities/entityId/fields/batch \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'syncariId: ' \
  --data '[
  {
    "fieldId": "625cc578f283388ad173df90",
    "displayName": "account id",
    "referenceTo": "ACCOUNT",
    "referenceTargetField": "ID22",
    "dataType": "reference"
  },
  {
    "fieldId": "625cc578f283388ad173df91",
    "displayName": "city22",
    "length": "25532442",
    "required": false,
    "dataType": "string"
  }
]'

 

Response Sample

{
  "success": true,
  "requestId": "5621922414",
  "timestamp": "2022-11-04T06:27:45.739966Z",
  "result": {
    "successfulUpdatedFieldIds": [
      "625cc578f283388ad173df90",
      "625cc578f283388ad173df91"
    ],
    "failedUpdatedFieldIds": []
  }
}



Delete Field

Delete a field on a draft entity. Supported on for Syncari, Marketo, Amazon DynamoDB, and PostgreSQL Synapses.

 

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
required-table (1).svg

Path Parameters

 Name
 Type
 Required
entityId

Unique ID of the entity

string
required-table (1).svg
fieldId
Unique ID of field
string
required-table (1).svg

 

Example

Request Sample

curl --request DELETE \
  --url https://api.syncari.com/api/v1/entities/entityId/fields/fieldId \
  --header 'Accept: application/json' \
  --header 'Authorization: ' \
  --header 'clientRequestId: ' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "6428160052",
  "timestamp": "2022-02-04T02:53:40.961313Z",
  "result": {
    "id": "61f88ac79dcaf01a0f25766d",
    "createdBy": "61e2a0f134a0f06932046bab",
    "createdAt": "2022-02-01T01:20:07.982+00:00",
    "updatedBy": "61e2a0f134a0f06932046bab",
    "updatedAt": "2022-02-01T01:20:07.982+00:00",
    "entityId": "61f88ac79dcaf01a0f257643",
    "apiName": "Type",
    "status": "ACTIVE",
    "datastoreName": "Type",
    "displayName": "Account Type",
    "description": null,
    "compositeKey": null,
    "dataType": "picklist",
    "parentAttributeId": null,
    "referenceTargetField": null,
    "referenceTo": null,
    "length": 40,
    "precision": 0,
    "custom": false,
    "calculated": false,
    "createOnly": false,
    "idField": false,
    "multiValueField": false,
    "readOnly": false,
    "required": false,
    "syncariDefined": false,
    "system": false,
    "unique": false,
    "watermarkField": false,
    "picklistValues": [
      "Analyst",
      "Competitor",
      "Customer",
      "Integrator",
      "Investor",
      "Partner",
      "Press",
      "Prospect",
      "Reseller",
      "Other"
    ],
    "tags": [],
    "draft": true
  }
}


Share this

Was this article helpful?

0 out of 0 found this helpful