List Relationship Instances (Hub Data)

[This topic is pre-release documentation and is subject to change.]

List instances of a custom Relationship type within the specified Hub, using various criteria.

Request

There are several different formulations of this request.

Get a Relationship Instance by ID

Gets the specified relationship instance for the specified hub.

HTTP Verb Request URI
GET <hub-endpoint>/data/relationships('relationshipId')?api-version=2017-04-26


List All Relationship Instances

Lists all the relationship instances for the specified hub.

HTTP Verb Request URI
GET <hub-endpoint>/data/relationships?api-version=2017-04-26


List Relationship Instances By Type

Lists all the relationship instances of the specified custom type for the specified hub.

HTTP Verb Request URI
GET <hub-endpoint>/data/relationships?$filter=RelationshipType eq '<typeName>'&api-version=2017-04-26


Get Relationships Of a Profile by Profile ID

This operation is an extension of the Get Profile Instance by ID operation, and has the form:

HTTP Verb Request URI
GET <hub-endpoint>/data/<profileTypes>('<ProfileId>')/Relationships?api-version=2017-04-26

Get Relationships Of a Profile by StrongId

This operation is an extension of the Get Profile Instance by ID operation using strong IDs, and has one of the following forms, depending on how many properties are used to form the key of the strong ID:

HTTP Verb Request URI
GET <hub-endpoint>/data/<profileTypes>(KeyProperty='<kpValue>')/Relationships?api-version=2017-04-26
GET <hub-endpoint>/data/<profileTypes>(KeyProperty1='<kp1Value>', KeyProperty2='<kp2Value>')/Relationships?api-version=2017-04-26

URI Parameters

The parameters for the various formulations are as follows:

URI Parameter Required Description
Hub-endpoint Yes The base URL for your Customer Insights Hub


Response

The response includes an HTTP status code, a response body and a set of response headers.

Response Body

A collection of custom Relationship instances, of the form:

{
    "value": [<array-of-relationship-instances>]
    "nextLink": "<nextURL>"
}

The maximum number of instances per response is 30, with the nextURL string containing a pointer to the next "page" of results.

Status Code

  • 200 (OK) - The request completed successfully.