Cyan Web API - Version 1

GET api/messageBodies/putDataDelete

            Gets and example of the message body format for a "PutDataDelete" message.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "nodeIds": [
    "cfdb8392-fa0e-4a0b-a448-57859292ff02",
    "aa0b2073-afb9-49bb-9d7e-b3a284c63ad3",
    "24add8ee-a6cf-4bd3-b583-bc6c0edab108"
  ],
  "nodes": [
    {
      "tenantId": "23d724a6-b0a8-4c2f-8e8f-d49ec74c883c",
      "nodeId": "146e5465-2305-42c2-8fa7-8d13b907820e",
      "type": "sample string 3",
      "id": "sample string 4",
      "parentType": "sample string 5",
      "parentId": "sample string 6",
      "title": "sample string 7",
      "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"
        }
      },
      "cyanId": 8,
      "subjectToCleanup": true,
      "createdDateUtc": "2025-10-08T12:05:48.4819856+00:00",
      "updatedDateUtc": "2025-10-08T12:05:48.4819856+00:00"
    },
    {
      "tenantId": "23d724a6-b0a8-4c2f-8e8f-d49ec74c883c",
      "nodeId": "146e5465-2305-42c2-8fa7-8d13b907820e",
      "type": "sample string 3",
      "id": "sample string 4",
      "parentType": "sample string 5",
      "parentId": "sample string 6",
      "title": "sample string 7",
      "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"
        }
      },
      "cyanId": 8,
      "subjectToCleanup": true,
      "createdDateUtc": "2025-10-08T12:05:48.4819856+00:00",
      "updatedDateUtc": "2025-10-08T12:05:48.4819856+00:00"
    },
    {
      "tenantId": "23d724a6-b0a8-4c2f-8e8f-d49ec74c883c",
      "nodeId": "146e5465-2305-42c2-8fa7-8d13b907820e",
      "type": "sample string 3",
      "id": "sample string 4",
      "parentType": "sample string 5",
      "parentId": "sample string 6",
      "title": "sample string 7",
      "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"
        }
      },
      "cyanId": 8,
      "subjectToCleanup": true,
      "createdDateUtc": "2025-10-08T12:05:48.4819856+00:00",
      "updatedDateUtc": "2025-10-08T12:05:48.4819856+00:00"
    }
  ]
}

application/xml, text/xml

Sample:

<PutDataDeleteMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <NodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>cfdb8392-fa0e-4a0b-a448-57859292ff02</d2p1:guid>
    <d2p1:guid>aa0b2073-afb9-49bb-9d7e-b3a284c63ad3</d2p1:guid>
    <d2p1:guid>24add8ee-a6cf-4bd3-b583-bc6c0edab108</d2p1:guid>
  </NodeIds>
  <Nodes xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
    <d2p1:NodeRepresentation>
      <d2p1:CreatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:CreatedDateUtc>
      <d2p1:UpdatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:UpdatedDateUtc>
      <d2p1:CyanId>8</d2p1:CyanId>
      <d2p1:Id>sample string 4</d2p1:Id>
      <d2p1:NodeId>146e5465-2305-42c2-8fa7-8d13b907820e</d2p1:NodeId>
      <d2p1:ParentId>sample string 6</d2p1:ParentId>
      <d2p1:ParentType>sample string 5</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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      </d2p1:Refs>
      <d2p1:SubjectToCleanup>true</d2p1:SubjectToCleanup>
      <d2p1:TenantId>23d724a6-b0a8-4c2f-8e8f-d49ec74c883c</d2p1:TenantId>
      <d2p1:Title>sample string 7</d2p1:Title>
      <d2p1:Type>sample string 3</d2p1:Type>
    </d2p1:NodeRepresentation>
    <d2p1:NodeRepresentation>
      <d2p1:CreatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:CreatedDateUtc>
      <d2p1:UpdatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:UpdatedDateUtc>
      <d2p1:CyanId>8</d2p1:CyanId>
      <d2p1:Id>sample string 4</d2p1:Id>
      <d2p1:NodeId>146e5465-2305-42c2-8fa7-8d13b907820e</d2p1:NodeId>
      <d2p1:ParentId>sample string 6</d2p1:ParentId>
      <d2p1:ParentType>sample string 5</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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      </d2p1:Refs>
      <d2p1:SubjectToCleanup>true</d2p1:SubjectToCleanup>
      <d2p1:TenantId>23d724a6-b0a8-4c2f-8e8f-d49ec74c883c</d2p1:TenantId>
      <d2p1:Title>sample string 7</d2p1:Title>
      <d2p1:Type>sample string 3</d2p1:Type>
    </d2p1:NodeRepresentation>
    <d2p1:NodeRepresentation>
      <d2p1:CreatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:CreatedDateUtc>
      <d2p1:UpdatedDateUtc>2025-10-08T12:05:48.4819856+00:00</d2p1:UpdatedDateUtc>
      <d2p1:CyanId>8</d2p1:CyanId>
      <d2p1:Id>sample string 4</d2p1:Id>
      <d2p1:NodeId>146e5465-2305-42c2-8fa7-8d13b907820e</d2p1:NodeId>
      <d2p1:ParentId>sample string 6</d2p1:ParentId>
      <d2p1:ParentType>sample string 5</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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d4p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <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:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      </d2p1:Refs>
      <d2p1:SubjectToCleanup>true</d2p1:SubjectToCleanup>
      <d2p1:TenantId>23d724a6-b0a8-4c2f-8e8f-d49ec74c883c</d2p1:TenantId>
      <d2p1:Title>sample string 7</d2p1:Title>
      <d2p1:Type>sample string 3</d2p1:Type>
    </d2p1:NodeRepresentation>
  </Nodes>
</PutDataDeleteMessageBody>