Retrieve the entity links for a given resource.
GET ~/resources/:resource-id/relations
Parameters
| Field | Type | Description |
|---|---|---|
| :resource-id | String |
The ID of the resource. |
Response
| Field | Type | Description |
|---|---|---|
| relations | Object |
An object describing each of the entity relationships for this resource. For example, a generic logo could be used by multiple locations, rather than each location having a duplicate image |
| locations | String[] |
A list of hashed location IDs linked to this resource. See Hashed Location IDs |
| apps | String[] |
A list of App IDs linked to this resource |
| vendors | String[] |
A list of Vendors IDs linked to this resource |
| menuProducts | Object[] |
A list of menu products linked to this resource |
| locationId | String |
The hashed location ID that is associated to the menu item. See Hashed Location IDs |
| posId | String |
The |
Examples
Response
{
"relations": {
"apps": [123]
"locations": ["2X3b8q"]
"menuProducts": [{
"locationId": "2X3b8q",
"posId": "pizza"
}],
"vendors": [456]
}
}
Comments
0 comments
Please sign in to leave a comment.