作業リストの取得（一括）

指定した期間に予定されている作業一覧を JSON ファイルまたは CSV ファイルで取得します。

「カレンダー表示作業の取得API」「作業リストの取得（単体）API」と異なり、複数店舗・複数日数の作業リストを一括取得 することができます。

呼び出しURL

{your-domain} の部分をご利用の環境にあわせて変更してください。

GET /h2/api/v1/task/list?{リクエストパラメータ}
X-ShopRun-Auth: {WebAPIキー}
Host: {your-domain}

リクエストパラメータ

リクエストパラメータサンプル

例）今日から15日間の作業を JSON 形式で取得する

curl -H 'X-ShopRun-Auth: {WebAPIキー}' 'https://{your-domain}/h2/api/v1/task/list?days=15' | jq

例）2022年1月26日 0:00(JST) から10日間の作業を CSV 形式で取得する

日付をクエリパラメーターにセットするとき、タイムゾーンを表す +09:00 の部分のプラス記号 (+) は URL エンコーディングして %2B として URL を生成する必要があります。

curl -H 'X-ShopRun-Auth: {WebAPIキー}' 'https://{your-domain}/h2/api/v1/task/list?from=2022-01-26T00:00:00%2B09:00&days=10&format=csv' -o {出力先パス}

注意事項

店舗数や作業数によってはデータの生成に長い時間を要する可能性があります。
呼び出し側のタイムアウト時間は、店舗数などに応じて適宜調整してください。

レスポンス

API の呼び出し結果は、format で指定したファイル形式で返されます。

JSON形式

[
  {
    "id": "作業のID",
    "store": {
      "storeCode": "店舗コード",
      "name": "店舗名",
      "type": "アカウントのタイプ 'store' or 'company'"
    },
    "title": "作業のタイトル",
    "description": "作業の説明",
    "notice": {
      "title": "お知らせのタイトル",
      "id": "お知らせの番号 (number)",
      "priority": "お知らせの重要度 (number) 3=通常, 4=重要, 7=緊急"
    },
    "pubGroup": {
      "groupCode": "発信部署のグループコード",
      "name": "発信部署名",
      "type": "group"
    },
    "categories": {
      "カテゴリーグループ名_ID": [
        "選択されているキー"
      ]
    },
    "dueDate": "締め切り日時 (ISO8601フォーマット 例. '2021-04-04T15:00:00Z')",
    "beginDate": "作業開始日時 (ISO8601フォーマット 例. '2021-04-04T15:00:00Z')",
    "repeat": "繰り返しタイプ (daily=毎日, weekly=毎週, every1week=隔週, monthly=毎月)",
    "volumePlanned": "予定工数 (number)",
    "volumeActual": "実績工数 (number)",
    "done": "実施状態 (boolean)",
    "lastModified": "実施状態の更新日時 (ISO8601)",
    "staff": "作業実施者",
    "memo": "作業メモ"
  }
]

CSV形式