メインコンテンツまでスキップ

User Conversions API

概要: 実行済みの文書変換ジョブの一覧を取得するAPIです。ページネーション、タイトル検索、タグフィルタリング機能により、効率的にジョブを管理できます。

GET /v1/user/conversions​

ジョブ一覧を取得します。

ページネーション、タイトル検索、タグフィルタリング機能を提供し、 失敗したジョブの除外も可能です。

GET /v1/user/conversions

Headers​

  • api-key : string(required) - rokadoc APIキー

Query Parameters​

必須パラメータ​

なし

オプショナルパラメータ
  • space_id : string(optional) - スペース機能を利用する場合はIDを入力
  • page : integer(optional) - ジョブ一覧で返却するページ番号 (デフォルト: 1, 最小: 1)
  • page_size : integer(optional) - 1ページあたり返却する件数 (デフォルト: 20, 最小: 1)
  • search_title : string(optional) - タイトルで検索
  • tags_filter : array(optional) - フィルター条件として指定するタグ
  • tags_filter_include : boolean(optional) - 指定したタグが含まれるものを返却するか否か。falseでタグが含まれないものが返却される (デフォルト: true)
  • status_filter : array(optional) - 検索で絞り込むジョブのステータス (Pending, Running, Succeeded, Failed, Retrying)

Request Example​

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/user/conversions?page=1&page_size=20&search_title=sample&tags_filter=${TAG}&tags_filter_include=true&space_id=${SPACE_ID}" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - ジョブ一覧取得成功​
{
    "code": 200,
    "total_count": 1,
    "last_page_number": 1,
    "data": [
        {
            "status": "Succeeded",
            "conversion_id": "xxxx",
            "document_name": "sample.pdf",
            "created_date": "202502051314",
            "updated_date": "202502051315"
        }
    ]
}
  • code : integer - ステータスコード
  • total_count : integer - 総件数
  • last_page_number : integer - 最終ページ番号
  • data : array - ジョブ情報の配列
    • status : string - ジョブのステータス (Pending, Running, Succeeded, Failed, Retrying)
    • conversion_id : string - 変換ID
    • document_name : string - ドキュメント名
    • created_date : string - 作成日時
    • updated_date : string - 更新日時
422 Validation Error​
{
    "detail": [
        {
            "type": "enum",
            "loc": ["query", "status_filter", 0],
            "msg": "Input should be 'Pending', 'Running', 'Succeeded', 'Failed' or 'Retrying'",
            "input": "Invalid",
            "ctx": {
                "expected": "'Pending', 'Running', 'Succeeded', 'Failed' or 'Retrying'"
            }
        }
    ]
}

注意事項​

  • ページネーションを利用して大量のデータを効率的に取得してください
  • タグフィルタリングを活用してジョブを絞り込むことができます
  • 特定のステータスのジョブだけ取得したい場合はstatus_filter=Running&status_filter=Failedの様に指定してください
  • スペース機能を利用している場合は適切なspace_idを指定してください