Get Review Item - Serval Documentation

GET

reviews

{review_id}

items

{item_id}

Get Review Item

curl --request GET \
  --url https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}', 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://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "item": {
      "id": "<string>",
      "resourceKind": "<string>",
      "resourceId": "<string>",
      "draftResourceId": "<string>",
      "operation": "REVIEW_ITEM_OPERATION_UNSPECIFIED",
      "applyResult": {
        "applied": {}
      }
    },
    "contentStatus": "REVIEW_ITEM_CONTENT_STATUS_UNSPECIFIED",
    "before": {},
    "after": {}
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	API key: `reviews:read` User: session review, User: promotion: Unsupported
Team-scoped API key	API key: `reviews:read` User: session review, User: promotion: Unsupported
User-based token (OAuth)	API key: Unsupported User: session review, User: promotion: Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

API key: The key must allow the session’s team, or either the source or target team of a promotion. The review’s target team must belong to your organization.
User: session review: Requires permission to view configuration sessions in the session’s team.
User: promotion: Requires review permission on the target team, or both staging permission on the target team and author permission on the source team.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

review_id

string

required

item_id

string

required

Response

200 - application/json

Success

data

data · object

Show child attributes

Get Review Item

curl --request GET \
  --url https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}', 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://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews/{review_id}/items/{item_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "item": {
      "id": "<string>",
      "resourceKind": "<string>",
      "resourceId": "<string>",
      "draftResourceId": "<string>",
      "operation": "REVIEW_ITEM_OPERATION_UNSPECIFIED",
      "applyResult": {
        "applied": {}
      }
    },
    "contentStatus": "REVIEW_ITEM_CONTENT_STATUS_UNSPECIFIED",
    "before": {},
    "after": {}
  }
}

​Authentication and permissions

Authorizations

Path Parameters

Response

Authentication and permissions