コンテンツにスキップ

一覧取得



GET /api/v1/notes/list

概要

現在のワークスペースで参照可能なレガシーノートを一覧表示します。

呼び出し前の前提と使用手順

名前によるフィルタリングをサポートします。ページネーションはありません。公開ノートと、現在の呼び出し元のアイデンティティが作成した非公開ノートを一覧表示できます。デフォルトではお気に入り項目が先頭に表示され、それ以外は作成日時の降順で表示されます。結果項目の uuid を使用して、詳細取得またはエクスポートを呼び出します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
search string 名前の部分一致。省略または空欄の場合、名前による絞り込みは行いません。
null を許可: False
例: 巡检
取得または入力方法: ノート名からキーワードを取得し、URL エンコードして渡します。

パラメータ補足説明

レスポンスの data は、条件に一致した項目の完全なリストです。各項目の uuid を直接読み取ります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/notes/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=巡检'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示します。

フィールド 型 説明
content.data array<object> 条件に一致したノート。結果がない場合は []。
content.data[].id integer ノートレコード番号。
content.data[].uuid string ノート UUID。参照、変更、インポート、削除に使用します。
content.data[].name string ノート名。
content.data[].workspaceUUID string 所属ワークスペース。
content.data[].isPublic integer 公開範囲。1 は公開、0 は作成したアイデンティティのみ。
content.data[].extend object ノートの拡張設定。
content.data[].status integer ノートの現在のステータス。
content.data[].creator string 作成者のアイデンティティ ID。
content.data[].updator string 最終更新者のアイデンティティ ID。更新されていない場合は空になることがあります。
content.data[].createAt number 作成日時(Unix 秒)。
content.data[].updateAt number 最終更新日時(Unix 秒)。更新されていない場合は -1 になることがあります。
content.data[].deleteAt number 削除日時(Unix 秒)。削除されていない場合は -1。
content.data[].pos array<object> チャートの順序参照配列。
content.data[].pos[].chartUUID string チャート UUID。
content.data[].creatorInfo object 作成者情報。見つからない場合は空のオブジェクト。
content.data[].updatorInfo object 最終更新者情報。見つからない場合は空のオブジェクト。
content.data[].creatorInfo.uuid string 対応するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。
content.data[].creatorInfo.status integer 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントステータス。
content.data[].creatorInfo.wsAccountStatus integer 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバーのステータス。
content.data[].creatorInfo.username string 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントログイン名。
content.data[].creatorInfo.name string 対応するアイデンティティが見つかった場合に提供されることがあります。表示名。
content.data[].creatorInfo.iconUrl string 対応するアイデンティティが見つかった場合に提供されることがあります。アバター URL。
content.data[].creatorInfo.email string 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返る可能性があります。
content.data[].creatorInfo.mobile string 対応するアイデンティティが見つかった場合に提供されることがあります。連絡先。
content.data[].creatorInfo.countryCode string 対応するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。
content.data[].creatorInfo.acntWsNickname string 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。
content.data[].updatorInfo.uuid string 対応するアイデンティティが見つかった場合に提供されることがあります。アイデンティティ識別子。
content.data[].updatorInfo.status integer 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントステータス。
content.data[].updatorInfo.wsAccountStatus integer 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペースメンバーのステータス。
content.data[].updatorInfo.username string 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントログイン名。
content.data[].updatorInfo.name string 対応するアイデンティティが見つかった場合に提供されることがあります。表示名。
content.data[].updatorInfo.iconUrl string 対応するアイデンティティが見つかった場合に提供されることがあります。アバター URL。
content.data[].updatorInfo.email string 対応するアイデンティティが見つかった場合に提供されることがあります。アカウントのメールアドレス。API Key のアイデンティティの場合は、その識別子が返る可能性があります。
content.data[].updatorInfo.mobile string 対応するアイデンティティが見つかった場合に提供されることがあります。連絡先。
content.data[].updatorInfo.countryCode string 対応するアイデンティティが見つかった場合に提供されることがあります。電話番号の国または地域コード。
content.data[].updatorInfo.acntWsNickname string 対応するアイデンティティが見つかった場合に提供されることがあります。ワークスペース内のニックネーム。
content.data[].isFavourited boolean 呼び出し元のアイデンティティがお気に入りに登録しているかどうか。
content.declaration object または null ワークスペースのパブリック宣言。
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 11,
        "uuid": "note_example",
        "name": "生产巡检笔记",
        "workspaceUUID": "wksp_example",
        "isPublic": 1,
        "pos": [],
        "extend": {},
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {},
        "isFavourited": false
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対応方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している パラメータの解析に失敗しました Query パラメータ表と例を確認してください。

フィードバック

このページは役に立ちましたか?