本文へスキップ

投稿の取得

GET/v1/posts/{id}

投稿を本文、投票、画像、コミュニティとともに返します。

リクエスト

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

パラメーター

  • id

    パス必須

    項目のID(UUID)。

    テキスト

  • reveal

    クエリ任意

    1 にすると、ネタバレとしてマークされた投稿の本文を含めます。

    テキスト

    使用できる値1

レスポンス

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

  • idテキスト (uuid)
  • slugテキスト
  • communityオブジェクト
    • idテキスト (uuid)
    • slugテキスト
    • languageテキスト
    • kindテキスト
      使用できる値workboarduser
    • nameテキスト
    • iconUrlテキスト (uri)null になる場合あり
    • themeテキスト
      使用できる値violetblueskycyanemeraldgreenyellowamberrosepink
    • isSampletrue または false
  • authorオブジェクトnull になる場合あり
    • usernameテキスト
    • displayNameテキスト
    • avatarUrlテキスト (uri)null になる場合あり
  • authorFlairテキストnull になる場合あり
  • kindテキスト
    使用できる値textlinkimagepoll
  • titleテキストnull になる場合あり
  • excerptテキストnull になる場合あり
  • flairオブジェクトnull になる場合あり
    • idテキスト (uuid)
    • labelテキスト
    • toneテキスト
      使用できる値neutralaccentsuccesswarningdangervioletblueskycyanemeraldgreenyellowamberrosepink
  • spoilerオブジェクトnull になる場合あり
    • workTitleテキストnull になる場合あり
    • unitNumber数値null になる場合あり

      0以上

  • workオブジェクトnull になる場合あり
    • idテキスト (uuid)
    • titleテキスト
    • mediumテキスト
      使用できる値animedonghuaanimationmangamanhwamanhuawebtoon
    • slugテキスト
    • unitNumber数値null になる場合あり

      0以上

  • isAdulttrue または false
  • isPinnedtrue または false
  • isLockedtrue または false
  • score整数null になる場合あり

    -9007199254740991〜9007199254740991

  • commentCount整数

    0〜9007199254740991

  • reactionsオブジェクトのリスト
    • kindテキスト
      使用できる値lovelaughwowsadclapfirethinkangrypartycry
    • count整数

      0〜9007199254740991

  • linkオブジェクトnull になる場合あり
    • urlテキスト (uri)
    • hostテキスト
    • titleテキストnull になる場合あり
    • descriptionテキストnull になる場合あり
    • imageオブジェクトnull になる場合あり
      • urlテキスト (uri)
      • width整数

        0〜9007199254740991

      • height整数

        0〜9007199254740991

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

        0〜9007199254740991

    • isPendingtrue または false
  • imagesオブジェクトのリスト
    • urlテキスト (uri)
    • width整数

      0〜9007199254740991

    • height整数

      0〜9007199254740991

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

      0〜9007199254740991

  • pollオブジェクトnull になる場合あり
    • optionsオブジェクトのリスト
      • idテキスト (uuid)
      • labelテキスト
      • voteCount整数null になる場合あり

        0〜9007199254740991

    • totalVotes整数

      0〜9007199254740991

    • closesAtテキスト (date-time)
    • isClosedtrue または false
    • allowsMultipletrue または false
  • createdAtテキスト (date-time)
  • editedAtテキスト (date-time)null になる場合あり
  • bodyオブジェクトnull になる場合あり
    • blocks複数の形式のいずれかのリスト
      1. 選択肢1

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

            • typeテキスト
              使用できる値text
            • textテキスト
            • marks任意の値のリスト
          2. 選択肢2

            • typeテキスト
              使用できる値link
            • hrefテキスト (uri)
            • children任意の値のリスト
          3. 選択肢3

            • typeテキスト
              使用できる値mention
            • usernameテキスト
          4. 選択肢4

            • typeテキスト
              使用できる値spoiler
            • spoilerIdテキスト
            • children任意の値のリストnull になる場合あり
          5. 選択肢5

            • typeテキスト
              使用できる値break
      2. 選択肢2

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

            • typeテキスト
              使用できる値text
            • textテキスト
            • marks任意の値のリスト
          2. 選択肢2

            • typeテキスト
              使用できる値link
            • hrefテキスト (uri)
            • children任意の値のリスト
          3. 選択肢3

            • typeテキスト
              使用できる値mention
            • usernameテキスト
          4. 選択肢4

            • typeテキスト
              使用できる値spoiler
            • spoilerIdテキスト
            • children任意の値のリストnull になる場合あり
          5. 選択肢5

            • typeテキスト
              使用できる値break
      3. 選択肢3

        • typeテキスト
          使用できる値quote
        • childrenRichTextBlockのリスト
      4. 選択肢4

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

        • typeテキスト
          使用できる値code
        • textテキスト
  • isDeletedtrue または false

エラー

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

エラーについて読む