Skip to main content
POST
/
relationships
JavaScript SDK
const relationships = [
  {
     externalId: 'some_relationship',
     sourceExternalId: 'some_source_external_id',
     sourceType: 'asset' as const,
     targetExternalId: 'some_target_external_id',
     targetType: 'event' as const
  }
];
const createdRelationships = await client.relationships.create(relationships);
{
  "items": [
    {
      "externalId": "<string>",
      "sourceExternalId": "<string>",
      "sourceType": "asset",
      "targetExternalId": "<string>",
      "targetType": "asset",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "startTime": 1730204346000,
      "endTime": 1730204346000,
      "confidence": 0.5,
      "dataSetId": 4503599627370496,
      "labels": [
        {
          "externalId": "my.known.id"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json

Data required to create relationships. You can request a maximum of 1000 relationships per request.

items
object[]
required
Required array length: 1 - 1000 elements

Response

Relationships stored by CDF.

items
object[]
required
Required array length: 1 - 1000 elements
Last modified on April 23, 2026