本文へスキップ

レビューの取得

GET/v1/reviews/{id}

1件のレビューを、作品IDと、最も参考になったレビューに含まれるかどうかとともに返します。

リクエスト

Shell
curl -g "https://api.nogitsu.com/v1/reviews/{id}"

パラメーター

  • id

    パス必須

    項目のID（UUID）。

    テキスト

レスポンス

リクエストが成功すると、次のJSONとともに200が返ります。

  • workIdテキスト (uuid)
  • isTopHelpfultrue または false
  • reviewオブジェクト
    • idテキスト (uuid)
    • authorオブジェクト
      • usernameテキスト
      • displayNameテキスト
      • avatarUrlテキスト (uri)null になる場合あり
    • titleテキストnull になる場合あり
    • bodyオブジェクトnull になる場合あり
      • blocks複数の形式のいずれかのリスト

        1. 選択肢1

          • typeテキスト
            使用できる値paragraph
          • children複数の形式のいずれかのリスト

            1. 選択肢1

              • type任意の値
              • text任意の値
              • marks任意の値

            2. 選択肢2

              • type任意の値
              • href任意の値
              • children任意の値

            3. 選択肢3

              • type任意の値
              • username任意の値

            4. 選択肢4

              • type任意の値
              • spoilerId任意の値
              • children任意の値

            5. 選択肢5

              • type任意の値

        2. 選択肢2

          • typeテキスト
            使用できる値heading
          • children複数の形式のいずれかのリスト

            1. 選択肢1

              • type任意の値
              • text任意の値
              • marks任意の値

            2. 選択肢2

              • type任意の値
              • href任意の値
              • children任意の値

            3. 選択肢3

              • type任意の値
              • username任意の値

            4. 選択肢4

              • type任意の値
              • spoilerId任意の値
              • children任意の値

            5. 選択肢5

              • type任意の値

        3. 選択肢3

          • typeテキスト
            使用できる値quote
          • childrenRichTextBlockのリスト

        4. 選択肢4

          • typeテキスト
            使用できる値list
          • isOrderedtrue または false
          • itemsRichTextBlockのリストのリスト

        5. 選択肢5

          • typeテキスト
            使用できる値code
          • textテキスト
    • bodyLength整数

      0〜9007199254740991

    • hasSpoilertrue または false
    • spoilerUnit数値null になる場合あり

      0以上

    • sourceSpoilerオブジェクトnull になる場合あり
      • kindテキスト
        使用できる値mangamanhwamanhuawebtoonnovelother
      • unit数値null になる場合あり

        0以上

    • prosテキストのリストnull になる場合あり
    • consテキストのリストnull になる場合あり
    • imagesオブジェクトのリスト
      • urlテキスト (uri)
      • width整数

        0〜9007199254740991

      • height整数

        0〜9007199254740991

      • altテキストnull になる場合あり
      • variantWidths整数のリスト

        0〜9007199254740991

    • languageテキスト
    • scoreHalfPoints整数null になる場合あり

      1〜20

    • categoryScoresオブジェクト
    • trackingStatusテキストnull になる場合あり
      使用できる値plannedcurrentcompletedpauseddroppedrewatching
    • progressUnits数値null になる場合あり

      0以上

    • progressTotal整数null になる場合あり

      0〜9007199254740991

    • repeatCount整数

      0〜9007199254740991

    • authorStatsオブジェクト
      • reviewCount整数

        0〜9007199254740991

      • helpfulCount整数

        0〜9007199254740991

    • helpfulCount整数

      0〜9007199254740991

    • unhelpfulCount整数

      0〜9007199254740991

    • replyCount整数

      0〜9007199254740991

    • createdAtテキスト (date-time)
    • editedAtテキスト (date-time)null になる場合あり

エラー

他の操作と同様に、この操作も無効なパラメーターでは400、何も見つからない場合は404、リクエストが多すぎる場合は429を返すことがあります。すべてのエラーは同じ形式です。

エラーについて読む