メインコンテンツへスキップ
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
file
/
fetch
ファイル処理結果一覧を取得
curl --request GET \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/file/fetch \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "total": 100,
    "page": 1,
    "page_size": 20,
    "files": [
      {
        "id": 202412190001,
        "name": "invoice.pdf",
        "format": "<string>",
        "category": "invoice",
        "task_id": 202412190001,
        "task_detail_url": "<string>",
        "task_type": 1,
        "batch_number": 202412190001,
        "failure_causes": "<string>",
        "pages": [
          {
            "page": 1,
            "width": 1024,
            "height": 1024,
            "dpi": 144
          }
        ],
        "data": {
          "fields": [
            {
              "key": "インボイスコード",
              "identifier": "インボイスコード識別子",
              "value": "3100231130",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "key": "インボイス番号",
              "identifier": "インボイス番号識別子",
              "value": "28737000",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "items": [
            [
              {
                "key": "商品・サービス名",
                "value": "*Electronic Computer*Microcomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "仕様モデル",
                "value": "DMS-SC68",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ],
            [
              {
                "key": "商品・サービス名",
                "value": "*Mechanical Computer*Supercomputer Host",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              },
              {
                "key": "仕様モデル",
                "value": "AN/FSQ-7",
                "position": [
                  {
                    "page": 0,
                    "vertices": [
                      0,
                      0,
                      100,
                      0,
                      100,
                      100,
                      0,
                      100
                    ]
                  }
                ]
              }
            ]
          ],
          "tables": [
            {
              "tableName": "table1",
              "tableType": 0,
              "extractModel": "<string>",
              "items": [
                [
                  {
                    "key": "<string>",
                    "identifier": "<string>",
                    "value": "<string>",
                    "textInLines": [
                      {
                        "angle": 0,
                        "pos": [
                          1
                        ],
                        "page": 1,
                        "text": "テキスト内容",
                        "char_pos": [
                          [
                            1
                          ]
                        ]
                      }
                    ],
                    "position": [
                      {
                        "page": 123,
                        "vertices": [
                          123
                        ]
                      }
                    ],
                    "index": 123,
                    "confidence": 0.95
                  }
                ]
              ]
            }
          ],
          "stamps": [
            {
              "angel": 0,
              "page": 0,
              "text": "全国統一インボイス監督印",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "税務局印",
              "type": "Other",
              "color": "Red",
              "shape": "Oval Seal",
              "position": [
                0,
                0,
                100,
                0,
                100,
                100,
                0,
                100
              ]
            }
          ],
          "handwritings": [
            {
              "angel": 0,
              "page": 0,
              "text": "3月1日",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            },
            {
              "angel": 0,
              "page": 0,
              "text": "山田太郎",
              "position": [
                {
                  "page": 0,
                  "vertices": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ]
            }
          ],
          "invoiceVerifyResult": {
            "invoiceVerifyStatus": 0,
            "invoiceVerifyErrorCode": 0,
            "invoiceVerifyCanRetry": 0,
            "invoiceVerifyFailMsg": "1日の上限を超過しました"
          }
        },
        "document": {
          "pages": [
            {
              "angle": 123,
              "width": 123,
              "height": 123,
              "lines": [
                {
                  "text": "<string>",
                  "position": [
                    123
                  ],
                  "charPositions": [
                    [
                      123
                    ]
                  ]
                }
              ]
            }
          ]
        },
        "child_files": [
          {
            "id": 202412190001,
            "task_id": 202412190001,
            "task_detail_url": "<string>",
            "task_type": 1,
            "parent_task_id": 202412190001,
            "batch_number": 202412190001,
            "name": "invoice.pdf",
            "format": "<string>",
            "category": "invoice",
            "pages": [
              {
                "page": 1,
                "width": 1024,
                "height": 1024,
                "dpi": 144
              }
            ],
            "data": {
              "fields": [
                {
                  "key": "インボイスコード",
                  "identifier": "インボイスコード識別子",
                  "value": "3100231130",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "key": "インボイス番号",
                  "identifier": "インボイス番号識別子",
                  "value": "28737000",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "items": [
                [
                  {
                    "key": "商品・サービス名",
                    "value": "*Electronic Computer*Microcomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "仕様モデル",
                    "value": "DMS-SC68",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ],
                [
                  {
                    "key": "商品・サービス名",
                    "value": "*Mechanical Computer*Supercomputer Host",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  },
                  {
                    "key": "仕様モデル",
                    "value": "AN/FSQ-7",
                    "position": [
                      {
                        "page": 0,
                        "vertices": [
                          0,
                          0,
                          100,
                          0,
                          100,
                          100,
                          0,
                          100
                        ]
                      }
                    ]
                  }
                ]
              ],
              "tables": [
                {
                  "tableName": "table1",
                  "tableType": 0,
                  "extractModel": "<string>",
                  "items": [
                    [
                      {
                        "key": "<string>",
                        "identifier": "<string>",
                        "value": "<string>",
                        "textInLines": [
                          {
                            "angle": 0,
                            "pos": [
                              1
                            ],
                            "page": 1,
                            "text": "テキスト内容",
                            "char_pos": [
                              [
                                1
                              ]
                            ]
                          }
                        ],
                        "position": [
                          {
                            "page": 123,
                            "vertices": [
                              123
                            ]
                          }
                        ],
                        "index": 123,
                        "confidence": 0.95
                      }
                    ]
                  ]
                }
              ],
              "stamps": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "全国統一インボイス監督印",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "税務局印",
                  "type": "Other",
                  "color": "Red",
                  "shape": "Oval Seal",
                  "position": [
                    0,
                    0,
                    100,
                    0,
                    100,
                    100,
                    0,
                    100
                  ]
                }
              ],
              "handwritings": [
                {
                  "angel": 0,
                  "page": 0,
                  "text": "3月1日",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                },
                {
                  "angel": 0,
                  "page": 0,
                  "text": "山田太郎",
                  "position": [
                    {
                      "page": 0,
                      "vertices": [
                        0,
                        0,
                        100,
                        0,
                        100,
                        100,
                        0,
                        100
                      ]
                    }
                  ]
                }
              ],
              "invoiceVerifyResult": {
                "invoiceVerifyStatus": 0,
                "invoiceVerifyErrorCode": 0,
                "invoiceVerifyCanRetry": 0,
                "invoiceVerifyFailMsg": "1日の上限を超過しました"
              }
            },
            "document": {
              "pages": [
                {
                  "angle": 123,
                  "width": 123,
                  "height": 123,
                  "lines": [
                    {
                      "text": "<string>",
                      "position": [
                        123
                      ],
                      "charPositions": [
                        [
                          123
                        ]
                      ]
                    }
                  ]
                }
              ]
            },
            "from_parent_position_list": [
              1
            ],
            "crop_info": {
              "page": 123,
              "image角度": "<string>"
            }
          }
        ],
        "duration_ms": 10000,
        "total_page_num": 10,
        "parser_params": {
          "formula_level": 0,
          "apply_merge": 1,
          "table_text_split_mode": 0,
          "crop_dewarp": 0,
          "remove_watermark": 0,
          "dpi": 144,
          "parse_mode": "auto",
          "pdf_pwd": "<string>"
        }
      }
    ]
  }
}

承認

x-ti-app-id
string
header
必須
x-ti-secret-code
string
header
必須

クエリパラメータ

page
integer
デフォルト:1

ページ番号。デフォルトは 1

page_size
integer
デフォルト:1000

1 ページあたりの件数。デフォルトは 1000

workspace_id
string
必須

ワークスペース ID

batch_number
string

バッチ番号

file_id
string

ファイル ID

category
string

ファイルカテゴリ

recognition_status
enum<integer>

ファイル認識ステータス:

  • 0: 認識待ち
  • 1: 認識成功
  • 2: 認識失敗
  • 3: 分類中
  • 4: 抽出中
  • 5: 準備中
  • 6: ファイル分割中
  • 7: 画像クロップ中
  • 10: 分類完了(アップロードインターフェースの target_process が classify の場合のみ使用可能)
  • 20: 解析中
利用可能なオプション:
0,
1,
2,
3,
4,
5,
6,
7,
10,
20
verification_status
enum<integer>

ファイル検証ステータス 0: 検証待ち 2: 確認済み 3: 却下 4: 削除済み 5: 処理保留

利用可能なオプション:
0,
2,
3,
4,
5
start_time
string<date-time>

更新時刻で検索する開始時刻。RFC3339 形式(YYYY-MM-DDTHH:MM:SSZ)

:

"2024-01-01T00:00:00.000Z"

end_time
string<date-time>

更新時刻で検索する終了時刻。RFC3339 形式(YYYY-MM-DDTHH:MM:SSZ)

:

"2024-01-01T10:00:00.000Z"

with_document
boolean
デフォルト:false

文書の完全なテキスト認識結果を返すかどうか

with_task_detail_url
boolean
デフォルト:false

タスク詳細ページ URL を返すかどうか

レスポンス

200 - application/json

ファイル一覧の取得に成功

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明

result
object