本文へスキップ

公開リストの一覧

GET/v1/collections

メンバーが作成した公開リスト、または1つの作品を含むリストのみを返します。

リクエスト

Shell
curl "https://api.nogitsu.com/v1/collections"

パラメーター

  • cursor

    クエリ任意

    前のページの nextCursor の値。最初のページでは省略します。

    テキスト

  • workId

    クエリ任意

    この作品を含むリストのみ。

    テキスト (uuid)

  • language

    クエリ任意

    この言語で書かれたリストのみ。

    テキスト

レスポンス

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

  • itemsオブジェクトのリスト
    • 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)
  • nextCursorテキストnull になる場合あり

エラー

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

エラーについて読む