GET/{resource-id1}/{object-id}/relationships/{resource-id2}

Возвращает объекты, которые связаны с указанным объектом.

Формат запроса

GET https://jsonapi.partner2.yandex.com/vX/{resource-id1}/{object-id}/relationships/{resource-id2}

Параметр

Описание

resource-id1

Идентификатор первого ресурса.

object-id

Идентификатор объекта, который принадлежит первому ресурсу.

resource-id2

Идентификатор второго ресурса. Из списка объектов второго ресурса будут найдены объекты, связанные с указанным объектом.

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа

JSON

{
  "data": [
    {
      "id": "{string}",
      "type": "{string}"
    }
  ],
  "links": {
    "related": "{string}",
    "self": "{string}"
  }
}      

Параметры ответа

  • data Связанные объекты.

    • id Идентификатор связанного объекта.

    • type Тип ресурса.

  • links Ссылки на объекты, связанные с указанным объектом.

    • related Ссылка на список связанных объектов с параметрами.

    • self Ссылка на список связанных объектов.

Пример для JSON

Запрос:

curl -i -g -H "Accept: application/vnd.api+json" -H "Authorization: token bf..." -X GET "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/context_on_site_campaign"

Ответ:

HTTP/1.1 200 OK
Server: nginx/1.8.1
Date: Sun, 18 Dec 2016 12:39:50 GMT
Content-Type: application/vnd.api+json
Content-Length: 326
Connection: keep-alive
        
{
  "data": [
    {
      "id": "882",
      "type": "context_on_site_campaign"
    }
  ],
  "links": {
    "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/context_on_site_campaign",
    "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-3228-1/relationships/context_on_site_campaign"
  }
}