Link an Entities

Create a link between entities in the Hubstream instance.

HTTP Method

POST

Endpoint

/api/data/write/StandardIntelLiteWriter

Request URL

{Base URL}/api/data/write/StandardIntelLiteWriter

Sample Request Body

This sample JSON creates a new Domain (“Testing”) and links it to an existing Company entity (ID = 1) using the specified relationship (“Related Entities” with “Confirmed” quality).

{
  "EntityName": "Domain",
  "ParentEntityName": "Company",
  "Data": {
    "Meta": {
      "$charset": "UTF-8"
    },
    "Links": [
      {
        "$id": "Yi21J",
        "$fid": "tpbKT",
        "$tid": "2fmIw",
        "LinkName": "Related Entities",
        "LinkQuality": "Confirmed"
      }
    ],
    "Nodes": {
      "Company": [
        {
          "$id": "tpbKT",
          "ID": "1",
          "$isTemporary": true
        }
      ],
      "Domain": [
        {
          "$id": "2fmIw",
          "GUID": "e9c6525634af86bd3ca9ef1d8b3a6a99",
          "Name": "Testing"
        }
      ]
    }
  }
}

Parameters

Param Name	Data Type	Description
EntityName	String	The child entity to be linked (for example, Domain).
ParentEntityName	String	Name of the parent entity type (for example, Company).
$id (Links)	String	A dynamically generated identifier for the link object. Used to reference the link internally within the request.
$fid	String	A dynamically generated From identifier (parent entity).
$tid	String	A dynamically generated To identifier (child entity).
$isTemporary	Boolean	true or false. true indicates that the Company entity is temporary and may be created or resolved during processing.
LinkName	String	Name of the link relationship (for example, Related Entities).
LinkQuality	String	Quality or strength of the relationship. Eg: Confirmed
GUID	String	A dynamically generated globally unique identifier.
$id (Nodes)	String	A dynamically generated identifier used to match nodes with $fid and $tid in the link.
ID	Integer	ID of the link entity.
Name	String	Name of the link entity (for example, Linking Domain).

Curl Example

Multi-line format (for readability):

curl --header "Accept-Language: en" \
     --http1.1 \
     --insecure \
     --verbose \
     --ntlm \
     --user "device-name1\jdoe:P@ssw0rd" \
     -X POST \
     "https://hubstreamproduction.hubstreamonline.com/api/data/write/StandardIntelLiteWriter" \
     -H "Content-Type: application/json" \
     -d '{
       "EntityName": "Domain",
       "ParentEntityName": "Company",
       "Data": {
         "Meta": {
           "$charset": "UTF-8"
         },
         "Links": [
           {
             "$id": "Yi21J",
             "$fid": "tpbKT",
             "$tid": "2fmIw",
             "LinkName": "Related Entities",
             "LinkQuality": "Confirmed"
           }
         ],
         "Nodes": {
           "Company": [
             {
               "$id": "tpbKT",
               "ID": "1",
               "$isTemporary": true
             }
           ],
           "Domain": [
             {
               "$id": "2fmIw",
               "GUID": "e9c6525634af86bd3ca9ef1d8b3a6a99",
               "Name": "Testing"
             }
           ]
         }
       }
     }'

Single-line format (for terminal use)

curl --header "Accept-Language: en" --http1.1 --insecure --verbose --ntlm --user "device-name1\jdoe:P@ssw0rd" -X POST "https://hubstreamproduction.hubstreamonline.com/api/data/write/StandardIntelLiteWriter" -H "Content-Type: application/json" -d "{\"EntityName\":\"Domain\",\"ParentEntityName\":\"Company\",\"Data\":{\"Meta\":{\"$charset\":\"UTF-8\"},\"Links\":[{\"$id\":\"Yi21J\",\"$fid\":\"tpbKT\",\"$tid\":\"2fmIw\",\"LinkName\":\"Related Entities\",\"LinkQuality\":\"Confirmed\"}],\"Nodes\":{\"Company\":[{\"$id\":\"tpbKT\",\"ID\":\"1\",\"$isTemporary\":true}],\"Domain\":[{\"$id\":\"2fmIw\",\"GUID\":\"e9c6525634af86bd3ca9ef1d8b3a6a99\",\"Name\":\"Testing\"}]}}}"

Sample Responses

Status code 2XX indicates a successful request and response.

200 OK

Description: Operation succeeded

Response Body

{
  "ID": 1,
  "DataRow": {
    "RowError": "",
    "RowState": 2,
    "Table": [
      {
        "ID": 1,
        "Action": "INSERT",
        "EntityTypeID": 53,
        "GUID": "e9c65256-34af-86bd-3ca9-ef1d8b3a6a99"
      }
    ],
    "ItemArray": [
      1,
      "INSERT",
      53,
      "e9c65256-34af-86bd-3ca9-ef1d8b3a6a99"
    ],
    "HasErrors": false
  }
}