Quick Start

Varsha Neelesh
Varsha Neelesh
  • Updated

List Quick Starts

Lists different type of quick starts. The two options available are Shared and MarketPlace.

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
type string  

Type of quick starts to retrieve

Shared|MarketPlace

Example

Request Sample

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

Response Sample

{
  "success": true,
  "requestId": "5766595378",
  "timestamp": "2022-07-28T06:26:47.100883Z",
  "result": {
    "qsInstallId": "62e22c26a8ccd6ac1c2e97c3",
    "qsInstallStatus": "QUEUED"
  }
}

 


Install Quick Start

The API allows to install a quick start into the pipeline asynchronously. qsInstallId in the response can be used check the status of the installation.

 

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
qsId

Unique ID of the quickstart that needs to be installed

string
required-table (1).svg

Example

Request Sample

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

Response Sample

{
  "success": true,
  "requestId": "5766595378",
  "timestamp": "2022-07-28T06:26:47.100883Z",
  "result": {
    "qsInstallId": "62e22c26a8ccd6ac1c2e97c3"
  }
}

 


Install Quick Start (Advanced - With Config)

This API enables the user to install a quick start into the pipeline and further allows to resolve Synapse and Field mappings in the request. Installation is executed asynchronously. The value corresponding to jobId in the response can be used in the Get Job API to get the status. When completed, the Get Job API will return the Entity Pipeline Id that was created by the quick start.

 

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
qsId

Unique ID of the quick start that needs to be installed

string
required-table (1).svg

 

Body

 Name
 Type
 Required

installStrategy

string
required-table (1).svg
autoArrange
boolean
required-table (1).svg

synapses

qsSynapseName

synapseName

entities

    qsEntityApiName

    entityApiName

    fields

        qsFieldApiName

        fieldApiName

array[object]
string
string
array[object]
string
string
array[object]
string
string

required-table (1).svg

required-table (1).svg

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/quickstart/qsId/run \
  --header 'Accept: application/json, application/xml' \
  --header 'Authorization: ' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: ' \
  --data '{
  "installStrategy": "replace",
  "autoArrange": true,
  "synapses": [
    {
      "qsSynapseName": "Salesforce QS",
      "synapseName": "Salesforce",
      "entities": [
        {
          "qsEntityApiName": "Lead",
          "entityApiName": "Lead",
          "fields": [
            {
              "qsFieldApiName": "City",
              "fieldApiName": "Country"
            }
          ]
        }
      ]
    }
  ]
}'

Response Sample

{
  "success": true,
  "requestId": "7497986815",
  "timestamp": "2022-09-15T06:26:31.675998Z",
  "result": {
    "jobId": "6322c59705c256730e105664",
    "status": "queued",
    "jobDetails": {
      "quickstartId": "631187a78a17dacb9df9ded3"
    }
  }
}

 

 


Get Quick Start Installation Status

Use this API to query the status of a quick start installation. The statuses are: QUEUED, PROCESSING, SUCCESS, ERROR.

 

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
qsId string required-table (1).svg
qsInstallId number required-table (1).svg

Example

Request Sample

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

Response Sample

{
  "success": true,
  "requestId": "5766595378",
  "timestamp": "2022-07-28T06:26:47.100883Z",
  "result": {
    "qsInstallId": "62e22c26a8ccd6ac1c2e97c3",
    "qsInstallStatus": "QUEUED"
  }
}



Create Quick Start

Creates a quick start from existing approved pipelines.

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

Body

 Name
 Type
 Required
request
displayName
description
postInstallationInstruction
tags
shareWithInstances
shareWithOrg
entities
    pipelineId
    excludeFields
object
string
string
string
array[string]
array[string]
boolean
array[object]
string
array[object]
required-table (1).svg
icon
string
 

Example

Request Sample

curl --request POST --url https://api.syncari.com/api/v1/instances \
    --header 'Accept: application/json' \
    --header 'Authorization: FTON46895FBIl' \
    --header 'Content-Type: application/json' \
    --header 'clientRequestId: 123456789' \
    --header 'syncariId: VBKIUF' \
    --form icon= \
--form request=

Response Sample

{
  "success": true,
  "requestId": "8991808921",
  "timestamp": "2022-11-30T08:38:45.633790Z",
  "result": {
    "id": "63871689a4d9d65860b3a379",
    "displayName": "QS Display Name",
    "description": "Description",
    "postInstallationInstruction": "Post Install Instructions",
    "status": "APPROVED",
    "iconPath": "/arcade/api/v1/quickstart/icon/63871689a4d9d65860b3a379/NEW",
    "publishToQuickStartLibrary": "dontPublish",
    "shareWithOrg": false,
    "tags": [
      "tag 1",
      "tag 2"
    ],
    "requiredSynapses": [
      "Salesforce",
      "Mysql"
    ],
    "shareWithInstances": [
      "ONEGOS"
    ],
    "pipelines": [
      {
        "entities": {
          "apiName": "contact",
          "displayName": "Contact",
          "entityId": "61e2a1e234a0f06966a197bd",
          "fields": [
            {
              "datatype": "string",
              "fieldApiName": "channel",
              "fieldDisplayName": "Channel",
              "fieldId": "62006f167a476c0807a0732d"
            },
            {
              "datatype": "datetime",
              "fieldApiName": "createdAt_2",
              "fieldDisplayName": "Created At",
              "fieldId": "62037c874548d2c6f91d4c6c"
            },
            {
              "datatype": "string",
              "fieldApiName": "description",
              "fieldDisplayName": "Program Description",
              "fieldId": "62006f167a476c0807a0732f"
            },
            {
              "datatype": "string",
              "fieldApiName": "name",
              "fieldDisplayName": "Program Name",
              "fieldId": "62006f167a476c0807a07331"
            },
            {
              "datatype": "string",
              "fieldApiName": "status",
              "fieldDisplayName": "Status",
              "fieldId": "62006f167a476c0807a07332"
            }
          ]
        }
      }
    ]
  }
}

 

Share this

Was this article helpful?

0 out of 0 found this helpful