フィールド値の取得 (Get Field Values)
GET/apiv2/pub/schema/values/{field_name}documents_read
任意のフィールド — ドキュメント列、Grid カスタムフィールド、または GridLink カスタムフィールド — の個別の値を返します。トークンのユーザーがアクセスできるドキュメントの値のみが返されます。
リクエスト
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
field_name | string | フィールドの一覧取得 から取得したフィールド識別子(例: Documents.doc_type または customfields_grid_5.cfield_101)。 |
クエリパラメータ
| パラメータ | 型 | デフォルト | 説明 |
|---|---|---|---|
search | string | — | 部分文字列一致で値をフィルタリングします。 |
limit | integer | 100 | 返す値の最大数(1〜500)。 |
レスポンス
200 OK — 昇順に並べられた、個別の文字列値のフラットな配列。
エラー
| ステータス | 理由 |
|---|---|
| 400 | 不明なフィールド名の形式です |
| 401 | トークンが無効または期限切れです |
| 404 | カスタムフィールドテンプレートまたは列が見つかりません |
cURL
curl -i -X GET "https://portal.docwize.com/apiv2/pub/schema/values/Documents.doc_type" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
# Custom field values with search
curl -i -X GET "https://portal.docwize.com/apiv2/pub/schema/values/customfields_grid_5.cfield_101?search=INV&limit=20" \
-H "Authorization: Bearer <ACCESS_TOKEN>"
[
"Contract",
"Invoice",
"Memo",
"Report"
]