Cyan Web API - Version 1

GET api/messageBodies/transaction

            Gets an example of the message body format for a "Transaction" message.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "transactionType": "sample string 1",
  "clientCreatedDateUtc": "2025-04-17T16:52:40.9429106+00:00",
  "nodes": [
    {
      "nodeId": "6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f",
      "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": "6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f",
      "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": "6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f",
      "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"
        }
      }
    }
  ],
  "authenticationData": "sample string 2",
  "otherData": "sample string 3"
}

application/xml, text/xml

Sample:

<TransactionMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <AuthenticationData>sample string 2</AuthenticationData>
  <ClientCreatedDateUtc>2025-04-17T16:52:40.9429106+00:00</ClientCreatedDateUtc>
  <Nodes 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>6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f</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>6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f</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>6f6c7222-b0a2-48c7-ad54-ce33fe46fc5f</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>
  </Nodes>
  <OtherData>sample string 3</OtherData>
  <TransactionType>sample string 1</TransactionType>
</TransactionMessageBody>