ドキュメントExperience Platformプロセスマネージャー

[Beta]{class="badge informative"}

Process Manager API

最終更新日： 2026年11月10日

作成対象：

  • User

Adobe Experience PlatformのProcess Manager APIを使用して、プロセス定義の一覧表示、実行実行のレビュー、繰り返しスケジュールの管理を行います。

はじめに

APIを使用する前に、認証チュートリアル ​を完了してください。 そして、リクエストごとに次のヘッダーを含めます。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key： {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}
  • x-sandbox-name：{SANDBOX_NAME}
NOTE
Adobe Experience Platformのサンドボックスについて詳しくは、​ サンドボックスの概要ドキュメント ​を参照してください。

プロセス定義のリスト list-process-definitions

/process-definitions エンドポイントにGET リクエストを行うことで、現在のすべてのプロセス定義を一覧表示できます。

API 形式

GET /process-definitions

クエリパラメータ

使用可能なクエリパラメーターのリスト。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
パラメーター 説明
name 定義名の小文字を区別しない部分文字列フィルター。
sort 並べ替えフィールド。 サポートされている値は createdAt、updatedAt、name です。 デフォルトは createdAt です。
order 並べ替え順序： サポートされている値はascとdescです。 デフォルトは desc です。
pageSize ページあたりの項目。 サポートされる範囲は1 ～ 100です。 デフォルトは100です。
cursor 前の呼び出しによって返された不透明なページネーションカーソル。 offsetと相互排他的です。
offset ゼロベースのオフセット cursorと相互排他的です。

リクエスト

プロセス定義のリストを取得するためのサンプルリクエスト。
code language-shell 
curl -X GET "https://aep-maestro.adobe.io/process-definitions?sort=updatedAt&order=desc&pageSize=2" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、プロセス定義のリストを含むHTTP ステータス 200が返されます。

プロセス定義のリストを取得する際のサンプル応答。
code language-json 
{
  "items": [
    {
      "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
      "name": "onboard-new-customer",
      "imsOrg": "{ORG_ID}",
      "sandboxId": "{SANDBOX_ID}",
      "sandboxName": "prod",
      "tasks": [
          {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
            }
        }
      ],
      "createdAt": "2026-05-13T17:45:00Z",
      "updatedAt": "2026-05-13T17:45:00Z",
      "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
      },
      "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
      }
    }
  ],
  "offset": 0,
  "nextCursor": "opaque-pagination-cursor",
  "pageSize": 1,
  "total": 1,
  "hasMore": true
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2
フィールド 説明
definitionUuid プロセス定義のID。
name プロセス定義の名前。
imsOrg プロセス定義が属する組織のID。
sandboxId プロセス定義が属するサンドボックスのID。
sandboxName プロセス定義が属するサンドボックスの名前。
tasks プロセス定義に関連するタスクオブジェクトを含む配列。
tasks.id タスクのID。
tasks.taskType タスクのタイプ。 指定できる値は、wait、ingest-data、verify-profile-ingestion、run-segmentation、run-profile-export、trigger-activation、run-data-distillerおよびsend-notificationです。
tasks.retry.maxAttempts タスクが失敗した場合にタスクが再試行される回数。
tasks.retry.backoffCoefficient
createdAt プロセス定義が作成された日時。
updatedAt プロセス定義が最後に更新された日時。
createdBy プロセス定義を作成したユーザーに関する情報を含むオブジェクト。
updatedBy プロセス定義を最後に更新したユーザーに関する情報を含むオブジェクト。

特定のプロセス定義の取得

プロセス定義IDを指定しながら/process-definitions エンドポイントにGET リクエストを行うことで、特定のプロセス定義を取得できます。

API 形式

GET /process-definitions/{DEFINITION_ID}
パラメーター
説明
{DEFINITION_ID}
プロセス定義のID。

リクエスト

指定されたプロセス定義を取得するためのサンプルリクエスト。
code language-shell 
curl -X GET "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、リクエストされたプロセス定義に関する情報を含むHTTP ステータス 200が返されます。

特定のプロセス定義を取得する際のサンプル応答。
code language-json 
{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "name": "onboard-new-customer",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "tasks": [
        {
            "id": "wait-task-id",
            "taskType": "wait",
            "retry": {
                "maxAttempts": 1,
                "backoffCoefficient": 2.0
        }
    }
    ],
    "createdAt": "2026-05-13T17:45:00Z",
    "updatedAt": "2026-05-13T17:45:00Z",
    "createdBy": {
        "userId": "{USER_ID}",
        "isService": false
    },
    "updatedBy": {
        "userId": "{USER_ID}",
        "isService": false
    }
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2
フィールド 説明
definitionUuid プロセス定義のID。
name プロセス定義の名前。
imsOrg プロセス定義が属する組織のID。
sandboxId プロセス定義が属するサンドボックスのID。
sandboxName プロセス定義が属するサンドボックスの名前。
tasks プロセス定義に関連するタスクオブジェクトを含む配列。
tasks.id タスクのID。
tasks.taskType タスクのタイプ。 指定できる値は、wait、ingest-data、verify-profile-ingestion、run-segmentation、run-profile-export、trigger-activation、run-data-distillerおよびsend-notificationです。
tasks.retry.maxAttempts タスクが失敗した場合にタスクが再試行される回数。
tasks.retry.backoffCoefficient
createdAt プロセス定義が作成された日時。
updatedAt プロセス定義が最後に更新された日時。
createdBy プロセス定義を作成したユーザーに関する情報を含むオブジェクト。
updatedBy プロセス定義を最後に更新したユーザーに関する情報を含むオブジェクト。

プロセス定義の実行のリスト list-process-definition-runs

/runs エンドポイントにGET リクエストを実行し、プロセス定義のIDを指定することで、プロセス定義のすべての実行のリストを取得できます。

API 形式

GET /runs?{QUERY_PARAMETERS}

クエリパラメータ

パラメーター
必須
説明
definitionUuid
○
実行のリストを取得するプロセス定義。
executionTrigger
×
MANUALまたはSCHEDULEまでに実行する結果をフィルターします。

リクエスト

指定したプロセス定義のすべての手動実行を取得するサンプルリクエスト。
code language-shell 
curl -X GET "https://aep-maestro.adobe.io/runs?definitionUuid=5b4e018b-f37c-4104-928b-b67148ce8537&executionTrigger=MANUAL" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、プロセス定義の実行情報を含むHTTP ステータス 200が返されます。

プロセス定義の実行を取得する際のサンプル応答。
code language-json 
[
  {
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
  }
]
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
フィールド 説明
runId 実行されるプロセス定義のID。
definitionUuid 実行が属するプロセス定義のID。
definitionName 実行が属するプロセス定義の名前。
imsOrg プロセス定義の実行が属する組織のID。
sandboxId プロセス定義の実行が属するサンドボックスのID。
sandboxName プロセス定義の実行先となるサンドボックスの名前。
state プロセス定義の実行状態。 指定できる値は、PENDING、RUNNING、COMPLETED、FAILED、CANCELED、TERMINATEDおよびTIMED_OUTです。
submittedAt プロセス定義の実行が送信された日時。
startedAt プロセス定義の実行が実行を開始する日時。
events プロセス定義の実行の一部として実行されるタスクを含むオブジェクト。
triggeredBy プロセス定義が実行されたメソッド。 指定できる値はMANUALまたはSCHEDULEです。

特定のプロセス定義の実行を取得 get-process-definition-run

実行IDを指定しながら/runs エンドポイントにGET リクエストを実行することで、実行された特定のプロセス定義を取得できます。

API 形式

GET /runs/{RUN_ID}
パラメーター
説明
{RUN_ID}
実行されるプロセス定義のID。

リクエスト

指定したプロセス定義の実行を取得するためのサンプルリクエスト。
code language-shell 
curl -X GET "https://aep-maestro.adobe.io/runs/{RUN_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、指定されたプロセス定義実行に関する情報を含むHTTP ステータス 200が返されます。

プロセス定義の実行に関する情報を含むサンプル応答。
code language-json 
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "RUNNING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
フィールド 説明
runId 実行されるプロセス定義のID。
definitionUuid 実行が属するプロセス定義のID。
definitionName 実行が属するプロセス定義の名前。
imsOrg プロセス定義の実行が属する組織のID。
sandboxId プロセス定義の実行が属するサンドボックスのID。
sandboxName プロセス定義の実行先となるサンドボックスの名前。
state プロセス定義の実行状態。 指定できる値は、PENDING、RUNNING、COMPLETED、FAILED、CANCELED、TERMINATEDおよびTIMED_OUTです。
submittedAt プロセス定義の実行が送信された日時。
startedAt プロセス定義の実行が実行を開始する日時。
events プロセス定義の実行の一部として実行されるタスクを含むオブジェクト。
triggeredBy プロセス定義が実行されたメソッド。 指定できる値はMANUALまたはSCHEDULEです。

プロセス定義の実行を開始 start-run

/runs エンドポイントに対してPOST リクエストを実行することで、プロセス定義の実行を開始できます。

API 形式

POST /runs

リクエスト

プロセス定義の実行を開始するためのサンプルリクエスト。
code language-shell 
curl -X POST "https://aep-maestro.adobe.io/runs" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "inputs": {
      "customerEmail": "alice@example.com",
      "orgName": "ACME Corp"
    }
  }'
table 0-row-3 1-row-3 2-row-3
プロパティ タイプ 説明
definitionUuid 文字列 実行を開始するプロセス定義のID。
inputs オブジェクト プロセス定義で必要なフィールドを含むオプションのオブジェクト。

応答

リクエストが成功すると、HTTP ステータス 202 Accepted with the accepted run detailsが返されます。 実行は非同期で、state: PENDINGですぐに返されます。

プロセス定義の実行を開始する際のサンプル応答。
code language-json 
{
    "runId": "b4d8e7c0-6c31-4d77-9f3d-c7d8a99496d2",
    "definitionUuid": "5b4e018b-f37c-4104-928b-b67148ce8537",
    "definitionName": "Sample run",
    "imsOrg": "{ORG_ID}",
    "sandboxId": "{SANDBOX_ID}",
    "sandboxName": "prod",
    "state": "PENDING",
    "submittedAt": "2026-10-23T18:32:52.402Z",
    "startedAt": "2026-10-23T18:32:52.402Z",
    "events": [
        {
            "type": "PROCESS_STARTED",
            "taskId": "sample-task",
            "taskType": "wait",
            "attempt": 1,
            "occurredAt": "2026-10-23T18:33:07.402Z"
        }
    ],
    "triggeredBy": "MANUAL"
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2
フィールド 説明
runId 新しく受け入れた実行のID。
definitionUuid 実行のプロセス定義のID。
definitionName 実行が属するプロセス定義の名前。
imsOrg プロセス定義の実行が属する組織のID。
sandboxId プロセス定義の実行が属するサンドボックスのID。
sandboxName プロセス定義の実行先となるサンドボックスの名前。
state 実行の状態。 このプロセスは非同期なので、これはPENDINGになります。
submittedAt プロセス定義の実行が送信された日時。
startedAt プロセス定義の実行が実行を開始する日時。
events プロセス定義の実行の一部として実行されるタスクを含むオブジェクト。
triggeredBy プロセス定義が実行されたメソッド。 指定できる値はMANUALまたはSCHEDULEです。

プロセス定義スケジュールの取得 get-schedule

/process-definitions/{DEFINITION_ID}/schedule エンドポイントにGET リクエストを実行し、プロセス定義のIDを指定することで、プロセス定義のスケジュールを取得できます。

API 形式

GET /process-definitions/{DEFINITION_ID}/schedule
パラメーター
説明
{DEFINITION_ID}
スケジュールを所有するプロセス定義のID。

リクエスト

プロセス定義のスケジュールを取得するためのサンプルリクエスト。
code language-shell 
curl -X GET "https://aep-maestro.adobe.io/process-definitions/{DEFINITION_ID}/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、プロセス定義スケジュールに関する情報を含むHTTP ステータス 200が返されます。

プロセス定義スケジュールに関する情報を含むサンプル応答。
code language-json 
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
フィールド 説明
cron スケジュールのcron形式。 cron スケジュールの詳細については、cron式フォーマット ​のドキュメントを参照してください。
paused スケジュールが一時停止しているかどうかを示すブール値。
createdAt スケジュールが作成された日時。
updatedAt スケジュールが最後に更新された日時。
createdBy スケジュールを作成したユーザーの詳細を含むオブジェクト。
updatedBy スケジュールを最後に更新したユーザーの詳細を含むオブジェクト。

スケジュールの置き換え replace-schedule

プロセス定義のIDを指定しながら/process-definitions/{DEFINITION_ID}/schedule エンドポイントにPUT リクエストを行うことで、プロセス定義のスケジュールを置き換えることができます。

API 形式

PUT /process-definitions/{DEFINITION_ID}/schedule
パラメーター
説明
{DEFINITION_ID}
スケジュールを所有するプロセス定義のID。

リクエスト

プロセス定義のスケジュールを置き換えるサンプルリクエスト。
code language-shell 
curl -X PUT "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Content-Type: application/json" \
  -d '{
    "cron": "0 0 * * *"
  }'
table 0-row-3 1-row-3
プロパティ タイプ 説明
cron 文字列 スケジュールのcron形式。 cron スケジュールの詳細については、cron式フォーマット ​のドキュメントを参照してください。

応答

スケジュールを更新する際のサンプル応答。

リクエストが成功すると、更新されたスケジュールでHTTP ステータス 200が返されます。

code language-json 
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

プロセス定義スケジュールの削除 remove-schedule

プロセス定義のIDを指定しながら/process-definitions/{DEFINITION_ID}/schedule エンドポイントにDELETE リクエストを行うことで、プロセス定義に添付されているスケジュールを削除できます。

API 形式

DELETE /process-definitions/{DEFINITION_ID}/schedule
パラメーター
説明
{DEFINITION_ID}
プロセス定義のID。

リクエスト

プロセス定義のスケジュールを削除するためのサンプルリクエスト。
code language-shell 
curl -X DELETE "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、応答本文なしでHTTP 204が返されます。

指定したスケジュールを一時停止 pause-schedule

プロセス定義IDを指定しながら/process-definitions/{DEFINITION_ID}/schedule:pause エンドポイントにPOST リクエストを行うことで、プロセス定義のスケジュールを一時停止できます。

API 形式

POST /process-definitions/{DEFINITION_ID}/schedule:pause
パラメーター
説明
{DEFINITION_ID}
プロセス定義のID。

リクエスト

スケジュールを一時停止するためのサンプルリクエスト。
code language-shell 
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:pause" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、HTTP ステータス 200とスケジュールに関する情報が返されます。

スケジュールを一時停止する際の応答のサンプル。
code language-json 
{
  "cron": "0 0 * * *",
  "paused": true,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}

指定したスケジュールを再開します resume-schedule

プロセス定義IDを指定しながら/process-definitions/{DEFINITION_ID}/schedule:resume エンドポイントにPOST リクエストを行うことで、プロセス定義のスケジュールを再開できます。

API 形式

POST /process-definitions/{DEFINITION_ID}/schedule:resume
パラメーター
説明
{DEFINITION_ID}
プロセス定義のID。

リクエスト

スケジュールを再開する際のサンプルリクエスト。
code language-shell 
curl -X POST "https://aep-maestro.adobe.io/process-definitions/5b4e018b-f37c-4104-928b-b67148ce8537/schedule:resume" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"

応答

リクエストが成功すると、HTTP ステータス 200とスケジュールに関する情報が返されます。

スケジュールを再開する際の応答のサンプル。
code language-json 
{
  "cron": "0 0 * * *",
  "paused": false,
  "createdAt": "2026-10-23T20:50:40.581Z",
  "updatedAt": "2026-10-23T20:50:40.581Z",
  "createdBy": {
    "userId": "{USER_ID}",
    "isService": false
  },
  "updatedBy": {
    "userId": "{USER_ID}",
    "isService": false
  }
}
recommendation-more-help
experience-platform-help-process-manager