スケジュール実行一覧の取得

GEThttps://api.omise.co/schedules/:id/occurrences

特定のスケジュールのすべての実行を一覧表示します。実行はスケジュールの個々の実行を表し、過去の課金/送金とスケジュールされた今後のイベントを含みます。このエンドポイントを使用して、サブスクリプション履歴の監視、支払い成功率の追跡、スケジュールされた今後の支払いの確認ができます。

---

リクエストパラメータ

必須 - 1項目パスパラメータ

▼

`id`STRING(required)

実行を一覧表示するスケジュールID。スケジュールIDはschd_で始まり、テストモードの場合はtest_が続きます。

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

任意 - 3項目ページネーションパラメータ

▼

`limit`INTEGER(optional)

1ページあたりに返す実行数。

Example:20

Constraints:最小値: 1, 最大値: 100, デフォルト: 20

Default:20

`offset`INTEGER(optional)

ページネーションでスキップする実行数。limitと組み合わせて大きな結果セットをページネートします。

Example:0

Default:0

`order`STRING(optional)

結果のソート順。

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

任意 - 2項目フィルターパラメータ

▼

---

レスポンス

200

取得成功

指定されたスケジュールの実行オブジェクトのページネーションされたリストを返します。各実行は単一の実行イベントを表します。

レスポンスに含まれる項目:

• data - 実行オブジェクトの配列
• limit - 1ページあたりの結果数
• offset - スキップされた結果数
• total - 実行の総数
• order - 適用されたソート順

実行オブジェクトのフィールド:

• id - 実行識別子（occu_*）
• schedule - 親スケジュールID
• scheduled_on - 実行がスケジュールされた/されている日付
• processed_at - 処理されたタイムスタンプ（保留中の場合はnull）
• status - scheduled、successful、failed、skipped
• result - 作成された課金または送金ID（成功した場合）
• message - エラーメッセージ（失敗した場合）

400

不正なリクエスト

リクエストの検証に失敗しました。詳細はエラーメッセージを確認してください。

一般的な原因:

• 無効な日付形式（ISO 8601である必要があります）
• limitが最大値（100）を超過
• 無効なorderパラメータ

401

認証エラー

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

スケジュールが見つからないか存在しません。

一般的な原因:

• 無効なスケジュールID
• 別のアカウントのスケジュールID
• テストモードと本番モードのキーの混同
• スケジュールが削除されている

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービス障害を確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/schedules/schd_test_5xuy4w91xqz7d1w9u0t/occurrences \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = Omise::Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')
occurrences = schedule.occurrences({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = omise.Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')
occurrences = schedule.occurrences(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const occurrences = await omise.schedules.listOccurrences(
  'schd_test_5xuy4w91xqz7d1w9u0t',
  {
    limit: 20,
    offset: 0
  }
);

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');
$occurrences = $schedule->occurrences(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Occurrence> occurrences = client.schedules()
    .listOccurrences("schd_test_5xuy4w91xqz7d1w9u0t")
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var occurrences = await client.Schedules.ListOccurrences(
    "schd_test_5xuy4w91xqz7d1w9u0t",
    new ListRequest
    {
        Limit = 20,
        Offset = 0
    }
);

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

occurrences, _ := client.ListScheduleOccurrences(
    "schd_test_5xuy4w91xqz7d1w9u0t",
    &operations.ListOccurrences{
        List: operations.List{
            Limit:  20,
            Offset: 0,
        },
    },
)

---

エラーコードと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいことを確認
not_found	スケジュールが見つからない	スケジュールIDと正しいモード（test/live）を確認
invalid_date_format	日付がISO 8601形式でない	形式を使用：YYYY-MM-DDTHH:MM:SSZ

実行ステータス値

ステータス	説明
scheduled	実行は保留中、まだ実行されていない
successful	課金/送金が正常に完了
failed	課金/送金が失敗（詳細はmessageを参照）
skipped	実行がスキップされた（スケジュールが一時停止または削除）

レスポンス例

{
  "object": "list",
  "data": [
    {
      "object": "occurrence",
      "id": "occu_test_5xuy4w91xqz7d1w9u0t",
      "location": "/occurrences/occu_test_5xuy4w91xqz7d1w9u0t",
      "schedule": "schd_test_5xuy4w91xqz7d1w9u0t",
      "scheduled_on": "2025-01-15",
      "processed_at": "2025-01-15T00:00:05Z",
      "status": "successful",
      "result": "chrg_test_5xuy4w91xqz7d1w9u0t",
      "message": null,
      "created_at": "2025-01-01T00:00:00Z"
    },
    {
      "object": "occurrence",
      "id": "occu_test_5xuy4w91xqz7d1w9u0u",
      "location": "/occurrences/occu_test_5xuy4w91xqz7d1w9u0u",
      "schedule": "schd_test_5xuy4w91xqz7d1w9u0t",
      "scheduled_on": "2025-02-01",
      "processed_at": null,
      "status": "scheduled",
      "result": null,
      "message": null,
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "limit": 20,
  "offset": 0,
  "total": 2,
  "order": "chronological"
}

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

あなたのIP: ...読み込み中...