本文へスキップ

リストの取得

GET/v1/collections/{id}

IDでリストを返します。名前、説明、所有者、テーマ、各種の数が含まれます。

リクエスト

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

パラメーター

  • id

    パス必須

    項目のID(UUID)。

    テキスト

レスポンス

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

  • idテキスト (uuid)
  • nameテキスト
  • slugテキスト
  • pathテキスト
  • descriptionテキストnull になる場合あり
  • visibilityテキスト
    使用できる値publicunlistedprivate
  • isOrderedtrue または false
  • languageテキスト
    使用できる値entrdefresptitruidjakozh
  • itemCount整数

    0〜9007199254740991

  • subscriberCount整数

    0〜9007199254740991

  • ownerオブジェクト
    • usernameテキスト
    • displayNameテキスト
    • avatarUrlテキスト (uri)null になる場合あり
  • coversオブジェクトのリスト
    • urlテキスト (uri)
    • variantWidths整数のリスト

      -9007199254740991〜9007199254740991

  • isRemovedtrue または false
  • isIndexabletrue または false
  • createdAtテキスト (date-time)
  • updatedAtテキスト (date-time)
  • themeオブジェクトnull になる場合あり
    • backgroundテキスト
    • accentテキスト
    • fontテキスト
      使用できる値defaultserifmono
    • densityテキスト
      使用できる値comfortablecompact
    • layoutテキスト
      使用できる値rowsposters
    • showsCurrentlyConsumingtrue または false
  • copiedFromオブジェクトnull になる場合あり
    • nameテキスト
    • pathテキスト
    • ownerDisplayNameテキスト

エラー

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

エラーについて読む