Get Upward Account Hierarchy
The Get Upward Family tree API allows you to request all parent organizations (all organizations from the current organization to its global ultimate) for a current organization.
The API takes the entity URI of the organization as the input, and passes the DUNS number of the organization for which all the parent organizations are requested.
For more information, see Hierarchies and Relationships.
Request
POST {DnBConnectorUri}/getFamilyTree| Parameter | Name | Required | Details |
|---|---|---|---|
| Headers | Content-Type |
Yes | Must be Content-Type: application/json |
EnvironmentUrl |
Yes | The environment url of the tenant. Example: https://dev.reltio.com |
|
TenantId |
Yes | Tenant ID | |
|
|
No | Reltio username Note: Not required if you provide the Reltio token.
|
|
Reltio-Password |
No | Reltio password Note: Not required if you provide the Reltio token.
|
|
Authorization |
No |
Reltio token in the form Bearer: <<token>> Note: Not required if you provide the username and password.
|
|
DnB-User |
No | D&B account username or Consumer Key in Direct+. Note: Not required if you provide the D&B token.
|
|
DnB-Password |
No | D&B account password or Consumer Secret in Direct+. Note: Not required if you provide the D&B token.
|
|
DnB-Token |
No |
D&B token in the form Bearer: <<token>> Note: Not required if you provide the username and password.
|
|
| Query | entityURI |
Yes | Entity URI's in the form entities/XXXX |
plus |
No | true or false. The default value is false. If set to
true, the Direct+ based Get family tree call is started. Note: You must have a
token or an account with the privileges for Direct+ API usage. Otherwise, an
authentication error is raised. |
|
| Body | No |
Example - Request
POST https://dev-dnbconnector.reltio.com/b2bIntegration/dnb/getFamilyTree?entityURI=entities/1QvQsDUmResponse
{
"success": "OK",
"message": "Family tree successful",
"entities": [entities/sbrWEPB, entities/sbrWIfR, entities/1QvQsDUm]
}