--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # イベント管理トピックオープン API # イベント管理トピックオープン API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：7分イベント管理トピックオープン API は、メッセージブローカーを介してトピックを送信し、ServiceNowインスタンスに保存できるようにするエンドポイントを提供します。この API を使用すると、メッセージブローカーを介して作成されたトピックを ServiceNow トピック \[topic\] テーブルに保存できます。この API は `sn-api-notif-mgmt` 名前空間で実行され、sn_api_notif_mgmt.event_mgmt_integration ロールが必要です。 ## イベント管理トピックを開く - POST /sn_api_notif_mgmt/topic {#ariaid-title2} トピック \[sn_api_notif_mgmt_topic\] テーブルに新しいレコードを作成し、渡されたトピック情報をそのレコードに保存します。このエンドポイントを使用して、メッセージバスミドルウェアで作成されたトピックを ServiceNow インスタンス内のトピックと同期します。このエンドポイントを使用してトピックが作成されると、関連するトピックレコードの user_created フィールドが `false` に設定され、タイプフィールドが `エグレス`に設定されます。 ### URL 形式バージョニングされた URL: /api/sn_api_notif_mgmt/v1/topic デフォルト URL: /api/sn_api_notif_mgmt/topic ### サポートされている要求パラメーター {#evt_man_top-POST-topic__entry__2}{#evt_man_top-POST-topic__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#evt_man_top-POST-topic__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#evt_man_top-POST-topic__entry__10} | 名前 | Description (説明) | |-|-| | contentQuery | イベントのペイロードに適用するフィルター。このクエリは、イベントの重大度やチケットタイプなどの情報を検索するために使用されるより詳細なイベントフィルターです。このパラメーターは、入れ子になったクエリとして渡すことができます。たとえば、次のトラブルチケットイベントペイロードの場合、このクエリはペイロードの 「event」 オブジェクトにある属性に適用されます。 { "eventId":"dc2003c2c3bb3550054e20bdc0013136", "@type":"Troubleticket", "eventType":"TroubleTicketCreateEvent", "event":{ "troubleTicket":{ "short_description":"Test payload", "severity":3, "ticketType":"incident" } } } このパラメーターは、次の条件をサポートします。 * AND:`variable1=value1&variable2=value2&variable3=value3` など * OR:`variable1=value1,value2,value3` など * 階層変数:`variable1.variable2.variable3=value1` など {#evt_man_top-POST-topic__ul_ncp_nsm_zzb} 例: `"contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1",` このフィールドは、関連するトピックレコードのcontent_queryフィールドにマッピングされます。詳細については、『 [TMF688 Event Management API User Guide (TMF688 イベント管理 API ユーザーガイド](https://www.tmforum.org/resources/standard/tmf688-event-management-api-user-guide-v4-0-0/))』を参照してください。データタイプ：文字列 | | externalId | GUID などの、トピックの一意の外部識別子。このフィールドは、関連するトピックレコードのtopic_idフィールドにマッピングされます。データタイプ：文字列 | | ヘッダークエリ | イベントヘッダープロパティに適用するフィルター。このクエリは、関連するトピックについてリッスンするイベントのタイプを定義します。このパラメーターは、入れ子になったクエリとして渡すことができます。このパラメーターは、次の条件をサポートします。 * AND:`variable1=value1&variable2=value2&variable3=value3` など * OR:`variable1=value1,value2,value3` など * 階層変数:`variable1.variable2.variable3=value1` など例: `"headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent"` このフィールドは、関連するトピックレコードのheader_queryフィールドにマッピングされます。詳細については、『 [TMF688 Event Management API User Guide (TMF688 イベント管理 API ユーザーガイド](https://www.tmforum.org/resources/standard/tmf688-event-management-api-user-guide-v4-0-0/))』を参照してください。データタイプ：文字列 | | name | トピックの名前。このフィールドは、関連するトピックレコードのtopic_nameフィールドにマッピングされます。データタイプ：文字列 | | namespace | トピックの名前空間。関連付けられた名前空間がない場合は空です。このフィールドは、関連するトピックレコードの名前空間フィールドにマッピングされます。データタイプ：文字列 | [表 : 3. 要求本文パラメーター] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#evt_man_top-POST-topic__entry__22}{#evt_man_top-POST-topic__accept-JSON-only-entry-RESTAPI}{#evt_man_top-POST-topic__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 4. 要求ヘッダー] {#evt_man_top-POST-topic__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#evt_man_top-POST-topic__entry__32}{#evt_man_top-POST-topic__entry-200-status-code}{#evt_man_top-POST-topic__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | 成功。要求が正常に処理されました。 | | 400 | 渡されたトピック外部 ID は既に存在します。一意のトピック外部 ID を渡してください:渡された外部 ID がトピックテーブルに既に存在することを示します。トピック名、ヘッダークエリ、コンテンツクエリ、名前空間の一意の組み合わせを渡してください :トピック名、名前空間、ヘッダークエリ、およびコンテンツクエリの組み合わせが既に存在することを示します。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター {#evt_man_top-POST-topic__entry__40} | 名前 | Description (説明) | |-|-| | contentQuery | 作成されたトピックレコードのcontent_queryフィールドの値。データタイプ：文字列 | | externalId | 作成されたトピックレコードのtopic_idフィールドの値。データタイプ：文字列 | | ヘッダークエリ | 作成されたトピックレコードのheader_queryフィールドの値。このフィールドは、トピックに送信するイベントメッセージを決定するために、トピックピッカーフレームワークによって使用されます。データタイプ：文字列 | | id | 作成されたトピックレコードのSys_id。データタイプ：文字列 | | name | トピックの名前。データタイプ：文字列 | | namespace | 作成されたトピックレコードの名前空間フィールドの値。データタイプ：文字列 | [ ] ### cURL 要求次のコード例は、このエンドポイントを呼び出す方法を示しています。 curl "http://instance.servicenow.com/api/sn_api_notif_mgmt/topic" \ --request POST \ --header "Accept:application/json" \ --user 'username':'password' --data { "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "externalId": "ext001", "namespace": "telecomEvents" } 応答： { "externalId": "ext001", "name": "HighPriorityTroubleTicket", "headerQuery": "eventType=TroubleTicketStatusChangeEvent,TroubleTicketAttributeChangeEvent", "contentQuery": "troubleTicket.ticketType=incident&troubleTicket.severity=1", "namespace": "telecomEvents", "id": "7ee9850443c3f550461f99612bb8f223" }