POST/{resource-id}/{object-id}/action/{action-name}
Совершает указанное действие с объектом.
Формат запроса
POST https://jsonapi.partner2.yandex.com/vX/{resource-id}/{object-id}/action/{action-name}
|
Параметр |
Описание |
|
|
Идентификатор ресурса, в котором находится объект. |
|
|
Идентификатор объекта, над которым необходимо совершить действие. |
|
|
Действие, которое необходимо совершить с объектом Ограничение. Допустимые значения зависят от ресурса, к которому относится объект, и перечислены в параметре actions операции GET/{resource-id}/{object-id}. |
Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.
Формат ответа
JSON
{
"data":
{
"relationships": {
"{string}": {
"links": {
"related": "{string}",
"self": "{string}"
}
}
},
"id": "{string}",
"type": "{string}",
"attributes": {}
},
"meta": {
"fields": []
},
"links": {
"self": "{string}"
}
}
Параметры ответа
-
data Массив с информацией по указанному объекту.
-
relationships Связанные ресурсы и объекты.
-
links Ссылки на объекты, связанные с текущим объектом.
-
related Ссылка на список связанных объектов с параметрами.
-
self Ссылка на список связанных объектов.
-
-
-
id Идентификатор объекта.
-
type Тип ресурса.
-
attributes Параметры объекта.
-
-
meta Объект содержит метаинформацию.
- fields Параметры объекта.
-
links Ссылки, связанные с объектом.
- self Ссылка на текущий объект.
Пример для JSON
Запрос:
curl -i -g -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: token 66.." -X POST 'https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-1/action/duplicate'Ответ:
HTTP/1.1 200 OK Server: nginx/1.8.1 Date: Wed, 18 Jan 2017 17:33:25 GMT Content-Type: application/vnd.api+json Content-Length: 757 Connection: keep-alive { "data": { "relationships": { "context_on_site_campaign": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-2/context_on_site_campaign", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-2/relationships/context_on_site_campaign" } }, "pages": { "links": { "related": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-2/pages", "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-2/relationships/pages" } } }, "id": "R-A-1056-2", "type": "context_on_site_rtb", "attributes": {} }, "meta": { "fields": [] }, "links": { "self": "https://jsonapi.partner2.yandex.com/v1/context_on_site_rtb/R-A-1056-2" } }