--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # オートメーションセンター API # オートメーションセンター API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：21分 オート メーションセンター API は、ロボット、プロセス、および実行ジョブに関連するデータを作成および更新するためのエンドポイントを提供します。この API を利用することで、自動化ワークフローの詳細を オートメーションセンター ダッシュボードに統合して反映できます。 API の主要な概念: * ロボット:ボットプロセスを実行するソフトウェアエージェント。RPA ロボットは、有人モードまたは無人モードで動作できます。 * プロセス:特定のロボットで実行される RPA ワークフローのインスタンス。プロセスを一意に識別するには、プロセス ID とロボット ID の両方を指定する必要があります。 * 実行:あるリソースから別のリソースへの情報の転送 (メールからスプレッドシートへのデータのコピーなど) など、プロセス内で実行される個々のタスク。 API の使用方法: API を使用して、ロボット、プロセス、実行などのサードパーティの RPA ツールから オートメーションセンター にデータを送信できます。 推奨ワークフロー: 1. ロボットデータを送信します。 2. 送信したロボットにリンクされたプロセスデータを送信します。 3. 対応するロボットとプロセスを参照する実行データを送信します。 注: 関連付けられたロボットとプロセスが既に オートメーションセンター にキャプチャされていない実行データは、ダッシュボードに表示されません。 {#auto-api__ol_x5h_5bj_d2c} 追加情報： * イベント保持:この API を使用して作成されたイベントは、14 日後にインスタンスから自動的に削除されます (デフォルト設定)。 * レコード制限:各 API コールで最大 2,000 件のレコードを処理できます。この制限は変更できません。 * イベントの削除:この API はイベントの削除をサポートしていません。 {#auto-api__ul_hfq_ccj_d2c} この API では、 オートメーションセンター プラグインがアクティブである必要があり、ユーザーに sn_as.automation_technical_user ロールまたは sn_ac.automation_admin ロールが必要です。 ## オートメーションセンター - POST /sn_ac/automation/rpa {#ariaid-title2} ロボット、プロセス、および実行イベントを作成します。 これらのイベントにより、プロセスの自動化が実現します。これらは概要ダッシュボードと実行オートメーションセンターダッシュボードに表示され、複数の RPA ベンダーからの出力を測定および監視します。 ### URL 形式 バージョニングされた URL: /api/sn_ac/{api_version}/automation/rpa デフォルト URL: /api/sn_ac/v1/automation/rpa 注: 使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。 ### サポートされている要求パラメーター {#auto-POST-rpa__entry__2}{#auto-POST-rpa__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 | [表 : 1. パスパラメーター] {#auto-POST-rpa__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#auto-POST-rpa__entry__10} | 名前 | 説明 | |-|-| | departmentName (部門名) | プロセスおよびロボットイベントタイプのみ。 イベントが属する部門の名前。 この値は、イベントタイプに応じて次のテーブルに格納されます。 * process:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルの department フィールド。 * Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルの robot:部門フィールド。 データタイプ：文字列 | | ドメイン ID | イベントが属するドメインのSys_id。 この値は、イベントタイプに応じて次のテーブルに格納されます。 * 実行:自動化実行 \[sn_ac_automation_execution\] テーブルのsys_domainフィールド。 * プロセス:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルのsys_domainフィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルのsys_domainフィールド。 データタイプ：文字列 | | endtime | 実行イベントタイプのみ。 実行の終了時間。この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの \[end_time\] フィールドに格納されます。 形式:YYYY-MM-DD HH:MM:SS データタイプ：文字列 | | 環境 | 実行イベントタイプのみ。 URL などの実行環境。この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの environment フィールドに格納されます。 注: この値は ServiceNow インスタンスでは使用されず、実装に必要な任意の値を含めることができます。 データタイプ：文字列 | | errorMessage | 実行イベントタイプのみ。 エラーメッセージログの名前。この値は、自動化実行 \[sn_ac_automation_execution\] テーブルのメッセージフィールドに格納されます。 データタイプ：文字列 | | eventName | 必須です。イベントタイプの名前。この値は、処理するイベントのタイプを決定します。 有効な値 (大文字と小文字を区別): * 実行 * process * robot データタイプ：文字列 | | ID | 必須です。関連イベントの一意の数値識別子。 この値は、イベントタイプに応じて次のテーブルに格納されます。 * 実行:自動化実行 \[sn_ac_automation_execution\] テーブルのautomation_execution_idフィールド。 * プロセス:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルのcorrelation_idフィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルのcorrelation_idフィールド。 データタイプ:数値 (整数) | | name | プロセスおよびロボットイベントタイプのみ。 必須です。イベントの名前。 この値は、イベントタイプに応じて次のテーブルに格納されます。 * process:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルの名前フィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルの名前フィールド。 データタイプ：文字列 | | priority | 実行イベントタイプのみ。 実行の優先度。 有効な値 (大文字と小文字を区別): * クリティカル * 高 * 中 * 低 この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの priority フィールドに格納されます。 データタイプ：文字列 デフォルト:なし - ダッシュボードには表示されません。 | | processId | 実行イベントタイプのみ。 必須です。実行を実行するプロセスの一意の識別子。この値は、Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルの対応するプロセスレコードの correlation_id フィールドにあります。 この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの自動化フィールドに格納されます。 データタイプ：文字列 | | ロボット ID | 実行イベントタイプのみ。 必須です。実行を実行するロボットの一意の識別子。この値は、Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルの対応するロボットレコードの correlation_id フィールドにあります。 この値は、自動化実行 \[sn_ac_automation_execution\] テーブルのロボットフィールドに格納されます。 データタイプ：文字列 | | ソース | 必須です。イベントが属するソース (「servicenow_rpa」など)。この値は、自動化ソース \[sn_ac_automation_source\] テーブルの internal_name フィールドにあります。 この値は、イベントタイプに応じて次のテーブルに格納されます。 * 実行:自動化実行 \[sn_ac_automation_execution\] テーブルのソースフィールド。 * process:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルのソースフィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルのソースフィールド。 データタイプ：文字列 | | starttime | 実行イベントタイプのみ。 実行の開始時間。この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの \[start_time\] フィールドに格納されます。 データタイプ：文字列 形式:YYYY-MM-DD HH:MM:SS | | 状況 | ロボットおよび実行イベントタイプのみ。関連イベントのステータス。 ロボットに有効な値 (大文字と小文字を区別): * キャンセル * 完了 * エラー * キューに格納 * 実行中 デフォルト:キューに格納 実行可能な値 (大文字と小文字を区別): * 利用可能 * Busy * Disconnected * 新規 * レスポンシブ デフォルト:新規 この値は、イベントタイプに応じて次のテーブルに格納されます。 * 自動化実行 \[sn_ac_automation_execution\] テーブルの execution: state フィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルのrobot_stateフィールド。 データタイプ：文字列 | | status | プロセスイベントタイプのみ。 必須です。プロセスのステータス。 可能な値 (大文字と小文字を区別): * ビルド * メンテナンス中 * 使用中 * 廃止 この値は、Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルの \[life_cycle_stage_status\] フィールドに格納されます。 データタイプ：文字列 | | トリガー元 | 実行イベントタイプのみ。 実行のトリガーソース。この値は、自動化実行 \[sn_ac_automation_execution\] テーブルの \[trigger_by\] フィールドに格納されます。 注: この値は ServiceNow インスタンスでは使用されず、実装に必要な任意の値を含めることができます。 データタイプ：文字列 | | type | プロセスおよびロボットイベントタイプのみ。 プロセスには必須、ロボットにはオプションです。実行する処理のタイプ。 有効な値 (大文字と小文字を区別): * Attended * Unattended この値は、イベントタイプに応じて次のテーブルに格納されます。 * プロセス:Base ボットプロセス \[cmdb_ci_base_rpa_process\] テーブルのprocess_typeフィールド。 * ロボット:Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルのrobot_typeフィールド。 データタイプ：文字列 デフォルト:ロボットの無人 | | version | ロボットイベントタイプのみ。 ロボットのバージョン。 この値は、Base ロボット \[cmdb_ci_base_rpa_robot\] テーブルの version フィールドに格納されます。 データタイプ：文字列 | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー 次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。 {#auto-POST-rpa__entry__48}{#auto-POST-rpa__accept-RESTAPI}{#auto-POST-rpa__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json | [表 : 4. 要求ヘッダー] {#auto-POST-rpa__entry__54} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。 {#auto-POST-rpa__entry__58}{#auto-POST-rpa__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 失敗。必須フィールドがないか、要求に無効な値が含まれているため、要求が却下されました。関連するエラーメッセージに失敗の理由が記載されています。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター {#auto-POST-rpa__entry__64} | 名前 | 説明 | |-|-| | result | 要求が成功した場合は空です。失敗した場合は、追加情報が表示されます。 データタイプ: オブジェクト "result": { "fields": { "": [Array] } "reason": "String" } たとえば、レコード 1、2、および 3 のすべてに必須フィールドがない場合、次のようなメッセージが返されます。 { "result": { "fields": { "1": [ "id" ], "2": [ "status" ], "3": [ "name" ] }, "reason": "We are not able to process the data as following records have insufficient data" } } | [ ] ### cURL 要求 次のコード例は、3 つのロボットイベントタイプのレコードを投稿する方法を示しています。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 8001, name: "Quotes system Automation Robot", state: "Available", status: "In Use", version: 5.6, departmentName: "Customer Support", type: "Unattended", source: "servicenow_rpa", eventName: "robot" }, { id: 8002, name: "Invoice Matching Robot", state: "Responsive", status: "In Maintenance", version: 3, departmentName: "HR", type: "Unattended", source: "servicenow_rpa", eventName: "robot" }, { id: 8003, name: "Data Reconciliation Robot", state: "Busy", status: "Retired", version: 2, departmentName: "Finance", type: "Unattended", source: "servicenow_rpa", eventName: "robot" }] } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 {#auto-POST-rpa__example_ww5_514_4tb} 次のコード例は、3 つのプロセスイベントタイプレコードを投稿する方法を示しています。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 9001, name: "RPA Execution Process", status: "In Maintenance", type: "Attended", departmentName: "Customer Support", source: "servicenow_rpa", eventName: "process" }, { id: 9002, name: "Customer Onboarding", status: "In Use", type: "Attended", departmentName: "Finance", source: "servicenow_rpa", eventName: "process" }, { id: 9003, name: "Data Reconciliation", status: "Retired", type: "Unattended", departmentName: "HR", source: "servicenow_rpa", eventName: "process" }] }" \ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 次のコード例は、3 つの実行イベントタイプレコードを投稿する方法を示しています。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 7001, name: "Customer Onboarding", starttime: "2022-03-18 00:49:13", endtime: "2022-03-20 00:58:03", state: "Running", priority: "Critical", environment: "system", triggeredBy: "Schedule", processId: 9001, robotId: 8001, source: "servicenow_rpa", eventName: "execution" }, { id: 7002, name: "Data Reconciliation", starttime: "2022-04-30 00:19:11", endtime: "2022-05-02 00:41:35", state: "Error", priority: "Low", environment: "system", triggeredBy: "API", processId: 9002, robotId: 8002, source: "servicenow_rpa", eventName: "execution" }, { id: 7003, name: "Customer Onboarding", starttime: "2022-01-22 02:38:53", endtime: "2022-01-23 02:50:44", state: "Queued", priority: "Moderate", environment: "system", triggeredBy: "Schedule", processId: 9003, robotId: 8003, source: "servicenow_rpa", eventName: "execution" }] } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 次のコード例は、プロセスを作成または更新する方法を示しています。プロセスを作成するには、実行するプロセスに必要なすべてのパラメーターを、「process」に設定された eventName とともに渡します。プロセスの作成に必要な必須パラメーターは、 id、 type、 status、 name、および sourceです。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 9001, name: "RPA Execution Process", status: "In Maintenance", type: "Attended", departmentName: "Customer Support", source: "servicenow_rpa", eventName: "process" }] } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 次のコード例は、プロセスを公開する方法を示しています。「公開済み」に設定された status パラメーターを渡すことで、プロセスを公開できます。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 9002, name: "RPA Execution Process", status: "Published", type: "Attended", departmentName: "Customer Support", source: "servicenow_rpa", eventName: "process" }] } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 次のコード例は、ロボットを作成または更新する方法を示しています。ロボットを作成するには、ロボットのすべての必須パラメーターを「robot」に設定された eventName とともに渡します。ロボットを作成するために必要な必須パラメーターは、 id、 status、 name、および source です。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 8001, name: "Quotes system Automation Robot", state: "Available", status: "In Use", version: 5.6, departmentName: "Customer Support", type: "Unattended", source: "servicenow_rpa", eventName: "robot" } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None ### cURL 要求 次のコード例は、実行を作成または更新する方法を示しています。実行を作成するには、実行のすべての必須パラメーターを「実行」に設定された eventName とともに渡します。実行を作成するために必要な必須パラメーターは、 id、 processId、 robotId、および sourceです。 curl "https://instance.servicenow.com/api/sn_ac/automation/rpa" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{ records: [{ id: 7001, name: "Customer Onboarding", starttime: "2022-03-18 00:49:13", endtime: "2022-03-20 00:58:03", state: "Running", priority: "Critical", environment: "http://acqa.servicenow.com", triggeredBy: "Schedule", processId: 9001, robotId: 8001, source: "servicenow_rpa", eventName: "execution", errorMessage:"Error due to Inactivity" }] } "\ --user "username":"password" このエンドポイントは、成功した場合は HTTP ステータスコードを返し、失敗した場合は HTTP ステータスコードとエラーメッセージのみを返します。 None