XaitCPQ API

POST sync/run

Runs a set of syncs by event.

Request Information

URI

https://ofd-api.blueprintcpq.net/sync/run

URI Parameters

None.

Body Parameters

The sync options.

SyncConfig
NameDescriptionTypeAdditional information
SyncEvent

SyncEvent

None.
Token

string

None.
Properties

Dictionary of string [key] and Object [value]

None.
Endpoint

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "SyncEvent": 0,
  "Token": "sample string 1",
  "Properties": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Endpoint": "sample string 2"
}

text/html

Sample: 
{"SyncEvent":0,"Token":"sample string 1","Properties":{"sample string 1":{},"sample string 3":{}},"Endpoint":"sample string 2"}

application/xml, text/xml

Sample: 
<SyncConfig xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <Endpoint>sample string 2</Endpoint>
  <Properties xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Properties>
  <SyncEvent>Setup</SyncEvent>
  <Token>sample string 1</Token>
</SyncConfig>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>