Cyan Web API - Version 1

GET api/sync?{syncTokenId}&{pageSize}&{pageNumber}

            Gets the data associated with a SyncToken

Request Information

Parameters

Name	Description	Additional information
syncTokenId	The sync token created using POST api/syncTokens	Define this parameter in the request URI.
pageSize	The number of records to return in a page.	Define this parameter in the request URI.
pageNumber	The page number.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "pageSize": 1,
  "pageNumber": 2,
  "recordCount": 3,
  "totalCount": 4,
  "data": [
    {
      "nodeId": "999bcb62-b981-4785-9a8a-675890bab0b5",
      "type": "sample string 2",
      "id": "sample string 3",
      "parentType": "sample string 4",
      "parentId": "sample string 5",
      "title": "sample string 6",
      "props": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      },
      "refs": {
        "sample string 1": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 2": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 3": {
          "type": "sample string 1",
          "id": "sample string 2"
        }
      }
    },
    {
      "nodeId": "999bcb62-b981-4785-9a8a-675890bab0b5",
      "type": "sample string 2",
      "id": "sample string 3",
      "parentType": "sample string 4",
      "parentId": "sample string 5",
      "title": "sample string 6",
      "props": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      },
      "refs": {
        "sample string 1": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 2": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 3": {
          "type": "sample string 1",
          "id": "sample string 2"
        }
      }
    },
    {
      "nodeId": "999bcb62-b981-4785-9a8a-675890bab0b5",
      "type": "sample string 2",
      "id": "sample string 3",
      "parentType": "sample string 4",
      "parentId": "sample string 5",
      "title": "sample string 6",
      "props": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      },
      "refs": {
        "sample string 1": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 2": {
          "type": "sample string 1",
          "id": "sample string 2"
        },
        "sample string 3": {
          "type": "sample string 1",
          "id": "sample string 2"
        }
      }
    }
  ]
}

application/xml, text/xml

Sample:

<PagedListRepresentationOfNodeuBHS4oip xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Internal">
    <d2p1:Node>
      <d2p1:Id>sample string 3</d2p1:Id>
      <d2p1:NodeId>999bcb62-b981-4785-9a8a-675890bab0b5</d2p1:NodeId>
      <d2p1:ParentId>sample string 5</d2p1:ParentId>
      <d2p1:ParentType>sample string 4</d2p1:ParentType>
      <d2p1:Props xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Props>
      <d2p1:Refs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
      </d2p1:Refs>
      <d2p1:Title>sample string 6</d2p1:Title>
      <d2p1:Type>sample string 2</d2p1:Type>
    </d2p1:Node>
    <d2p1:Node>
      <d2p1:Id>sample string 3</d2p1:Id>
      <d2p1:NodeId>999bcb62-b981-4785-9a8a-675890bab0b5</d2p1:NodeId>
      <d2p1:ParentId>sample string 5</d2p1:ParentId>
      <d2p1:ParentType>sample string 4</d2p1:ParentType>
      <d2p1:Props xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Props>
      <d2p1:Refs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
      </d2p1:Refs>
      <d2p1:Title>sample string 6</d2p1:Title>
      <d2p1:Type>sample string 2</d2p1:Type>
    </d2p1:Node>
    <d2p1:Node>
      <d2p1:Id>sample string 3</d2p1:Id>
      <d2p1:NodeId>999bcb62-b981-4785-9a8a-675890bab0b5</d2p1:NodeId>
      <d2p1:ParentId>sample string 5</d2p1:ParentId>
      <d2p1:ParentType>sample string 4</d2p1:ParentType>
      <d2p1:Props xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Props>
      <d2p1:Refs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
        <d4p1:KeyValueOfstringNodeReff3T6mNRh>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>
            <d2p1:Id>sample string 2</d2p1:Id>
            <d2p1:Type>sample string 1</d2p1:Type>
          </d4p1:Value>
        </d4p1:KeyValueOfstringNodeReff3T6mNRh>
      </d2p1:Refs>
      <d2p1:Title>sample string 6</d2p1:Title>
      <d2p1:Type>sample string 2</d2p1:Type>
    </d2p1:Node>
  </Data>
  <PageNumber>2</PageNumber>
  <PageSize>1</PageSize>
  <RecordCount>3</RecordCount>
  <TotalCount>4</TotalCount>
</PagedListRepresentationOfNodeuBHS4oip>