Review explicit menu/location/channel targets and retained releases
curl --request POST \
--url https://api.example.com/api/v1/catalog/workspace/publication-review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedDraftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://api.example.com/api/v1/catalog/workspace/publication-review"
payload = {
"expectedDraftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedDraftRevision: 4503599627370495,
targets: [
{
menuId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.example.com/api/v1/catalog/workspace/publication-review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/catalog/workspace/publication-review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedDraftRevision' => 4503599627370495,
'targets' => [
[
'menuId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'locationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/catalog/workspace/publication-review"
payload := strings.NewReader("{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/catalog/workspace/publication-review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/catalog/workspace/publication-review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"draftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRevision": 4503599627370495
}
],
"retained": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRevision": 4503599627370495
}
],
"changes": [
{
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
},
"addedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"changedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"removedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"reorderedParentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"effectiveChanges": [
{
"kind": "price",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"before": {
"amount": "<string>",
"currency": "<string>",
"origin": "default"
},
"after": {
"amount": "<string>",
"currency": "<string>",
"origin": "default"
}
}
]
}
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
}
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
}
}
],
"confirmationToken": "<string>"
}API Reference
Review explicit menu/location/channel targets and retained releases
POST
/
api
/
v1
/
catalog
/
workspace
/
publication-review
Review explicit menu/location/channel targets and retained releases
curl --request POST \
--url https://api.example.com/api/v1/catalog/workspace/publication-review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedDraftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
'import requests
url = "https://api.example.com/api/v1/catalog/workspace/publication-review"
payload = {
"expectedDraftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expectedDraftRevision: 4503599627370495,
targets: [
{
menuId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
locationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
})
};
fetch('https://api.example.com/api/v1/catalog/workspace/publication-review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/catalog/workspace/publication-review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expectedDraftRevision' => 4503599627370495,
'targets' => [
[
'menuId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'locationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/catalog/workspace/publication-review"
payload := strings.NewReader("{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/catalog/workspace/publication-review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/catalog/workspace/publication-review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedDraftRevision\": 4503599627370495,\n \"targets\": [\n {\n \"menuId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"locationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"draftRevision": 4503599627370495,
"targets": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRevision": 4503599627370495
}
],
"retained": [
{
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online",
"menuReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"targetRevision": 4503599627370495
}
],
"changes": [
{
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
},
"addedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"changedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"removedEntityIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"reorderedParentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"effectiveChanges": [
{
"kind": "price",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"before": {
"amount": "<string>",
"currency": "<string>",
"origin": "default"
},
"after": {
"amount": "<string>",
"currency": "<string>",
"origin": "default"
}
}
]
}
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
}
}
],
"warnings": [
{
"code": "<string>",
"message": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": {
"menuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel": "online"
}
}
],
"confirmationToken": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Committed authoring evidence or read-only review; no publication is activated by a review.
Required range:
0 < x <= 9007199254740991Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Maximum array length:
10000Show child attributes
Show child attributes
Maximum array length:
1000Show child attributes
Show child attributes
Maximum array length:
100000Show child attributes
Show child attributes
Maximum array length:
100000Show child attributes
Show child attributes
Pattern:
^[a-f0-9]{64}$