トラブルチケットオープン API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：51分

トラブルチケットオープン API は、ケース [sn_customerservice_case]、インシデント [incident]、およびサービス問題ケース [sn_sprb_mgmt_case] テーブルからデータを作成、更新、および取得するためのエンドポイントを提供します。

この API を使用して、外部チケットシステムと ServiceNow AI Platform間のチケット情報を管理します。

この API は、プロアクティブサービスエクスペリエンスワークフロー ServiceNow Store で利用可能なアプリケーション。ケース [sn_customerservice_case] テーブルでこの API を使用するには、カスタマーサービス (com.sn_customerservice) アプリケーションとカスタマーサービスインストールベース管理 (com.snc.install_base) アプリケーションが必要です。

この API は、 sn_ind_tsm_sdwan 名前空間内で提供されます。

呼び出し元ユーザーには、ticket_integrator ロールが必要です。

この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。詳細については、「『 Trouble Ticket Open API Developer Guide (トラブルチケットオープン API 開発者ガイド)』を参照してください。

Trouble Ticket Open API は、TM Forum Trouble Ticket Management API REST 仕様のServiceNow®実装です。この実装は、 TMF621 Trouble Ticket Management API User Guide v5.0.0 (2024 年 9 月) に基づいています。Trouble Ticket Open API は、TM フォーラムによって適合性認定を受けています。

TMF 準拠ロゴ

トラブルチケット:GET /sn_ind_tsm_sdwan/ticket/troubleTicket

ケース [sn_customerservice_case]、インシデント [incident]、およびサービス問題ケース [sn_sprb_mgmt_case] テーブルからすべてのトラブルチケットレコードのリストを取得します。

URL 形式

デフォルト URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド：チャネル creationDate description href ID 前回の更新 name 注意 relatedEntity 関連パーティー severity status チケットタイプ @type デフォルト：すべてのフィールドを返します。データタイプ：文字列
ID	sys_idでトラブルチケットをフィルタリングします。指定されたsys_idのチケットのみが応答に返されます。データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。デフォルト：25 最大:100 デフォルト値と最大値は、 sn_ind_tsm_sdwan.pagination.set_limit と sn_ind_tsm_sdwan.pagination.max_limit システムプロパティを更新することで変更できます。データタイプ：数値
オフセット	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0
severity	重大度でトラブルチケットをフィルタリングします。指定した重大度のチケットのみが応答に返されます。データタイプ：文字列
status	ステータス別にトラブルチケットをフィルタリングします。指定したステータスのチケットのみが応答に返されます。データタイプ：文字列
チケットタイプ	チケットタイプ別にトラブルチケットをフィルタリングします。指定されたタイプのチケットのみが応答に返されます。有効な値：ケースインシデントサービスの問題ケースデータタイプ：文字列

表 : 3. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
なし

表 : 5. 応答ヘッダー
ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、 `offset=2` で `limit=3` の場合、 Content-Range ヘッダーの値は `アイテム 3 から 5` です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
「リンク」	クエリ結果間を移動するための次のリンクが含まれています。第 1 最終次へ前へ
X-合計-数	ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。
206	応答で返された部分的なリソース (ページネーションあり)。
400	要求が正しくありません。考えられる理由: 無効なパスパラメーター無効な URI
404	レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマッピングします。データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。[ 作成済み] フィールドにマッピングします。データタイプ：文字列
description	チケットの問題の説明。[ 説明] フィールドにマッピングします。データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。データタイプ：文字列
ID	ケースまたはインシデントレコードのsys_id。データタイプ：文字列
前回の更新	レコードが最後に更新された日付。[ 更新日時 ] フィールドにマッピングします。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。[ 簡単な説明] フィールドにマッピングします。データタイプ：文字列
注意	チケットに関するすべてのコメントのリスト。このリストには作業メモは含まれません。データタイプ：アレイ `"note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。コメントのみが返されるため (作業メモは返されません)、この値は常に `コメント`です。データタイプ：文字列
note.author	コメントを作成する POST または PATCH 要求を行った ServiceNow 統合ユーザーの名前。データタイプ：文字列
note.date	ServiceNowインスタンスでコメントが作成された日付。データタイプ：文字列
note.text	コメントテキスト。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.href	空の文字列を返します。データタイプ：文字列
relatedEntity.name	影響を受けるアイテムまたはサービスの名前。データタイプ：文字列
relatedEntity.role	影響を受けるアイテムまたはサービスの説明。データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
relatedEntity.@type	この値は常に `relatedEntity` です。データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。チケットタイプと関係者タイプに応じて、次のテーブルからsys_idできます。ケース: アカウント [customer_account];関係者タイプは`顧客`です連絡先 [customer_contact];関係者タイプが `customer_contact` インシデント: 会社 [core_company];関係者タイプは`顧客`ですユーザー [sys_user];関係者タイプが `customer_contact` ケースまたはインシデント: グループ [sys_user_group];関係者タイプが `assignment_group` ユーザー [sys_user];関係者タイプが `assigned_to` データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.@referredType	関係者のタイプ。可能な値： `assigned_to`:チケットの作業をアサインされたユーザー。 `assignment_group`:チケットの作業にアサインされたグループ。 `顧客`:チケットの会社またはアカウント。 `customer_contact`:チケットの発信者または連絡先。データタイプ：文字列
severity	トラブルチケットで説明されている問題の重大度。[ 優先度] フィールドにマップします。データタイプ：文字列
status	トラブルチケットの現在のステータス。[ ステータス ] フィールドにマッピングします。データタイプ：文字列
チケットタイプ	チケットのタイプ。可能な値：ケースインシデントサービスの問題ケースデータタイプ：文字列
@type	この値は常に `TroubleTicket` です。データタイプ：文字列

cURL 要求

この例では、最初の 5 つのトラブルチケットケースレコードについて指定されたフィールドを返します。

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket?limit=5&fields=id%2Cname%2Cdescription%2Cstatus%2Cseverity%2CticketType&ticketType=case" \
--request GET \
--user 'username':'password'

応答本文。

[
   {
      "id": "0004609eb9830110f877b3758cd21d37",
      "name": "Compliant Over 2796",
      "description": "checkNo2796",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "000560d2b9c30110f877b3758cd21d36",
      "name": "Compliant Over 4696",
      "description": "checkNo4696",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d34",
      "name": "Compliant Over 8817",
      "description": "checkNo8817",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d39",
      "name": "Compliant Over 8819",
      "description": "checkNo8819",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   },
   {
      "id": "0007ac5eb9c30110f877b3758cd21d3e",
      "name": "Compliant Over 8821",
      "description": "checkNo8821",
      "status": "New",
      "severity": "3 - Moderate",
      "ticketType": "Case"
   }
]

トラブルチケット:GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

ケース [sn_customerservice_case]、インシデント [incident]、またはサービス問題ケース [sn_sprb_mgmt_case] テーブルから指定されたレコードを取得します。

URL 形式

デフォルト URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
ID	取得するケースまたはインシデントレコードのSys_id。データタイプ：文字列テーブル:ケース [sn_customerservice_case] またはインシデント [incident]

表 : 8. クエリパラメーター
名前	説明
フィールド	応答で返すフィールドのリスト。無効なフィールドは無視されます。有効な値：チャネル creationDate description href ID 前回の更新 name 注意 relatedEntity 関連パーティー severity status チケットタイプ @type データタイプ：文字列デフォルト：すべてのフィールドを返します。

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。次の 1 つ以上の理由で、不正な要求タイプまたは誤った形式の要求が検出されました。パスパラメーターが無効です。無効な URI。
404	レコードが見つかりません。ID に関連付けられたレコードがケース [sn_customerservice_case] またはインシデント [incident] テーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマッピングします。データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。[作成済み] フィールドにマッピングします。データタイプ：文字列
description	チケットからの問題の説明。[説明] フィールドにマッピングします。データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。データタイプ：文字列
ID	ケースまたはインシデントレコードのSys_id。データタイプ：文字列
前回の更新	レコードが最後に更新された日付。[更新日時] フィールドにマッピングします。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。[簡単な説明] フィールドにマッピングします。データタイプ：文字列
注意	チケットに関するすべてのコメントのリスト。このリストには作業メモは含まれません。データタイプ：オブジェクトのアレイ `"note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。コメントのみが返されるため (作業メモは返されません)、この値は常に `コメント`です。データタイプ：文字列
note.author	コメントを作成したユーザーの名前。データタイプ：文字列
note.date	ServiceNowインスタンスでコメントが作成された日付。データタイプ：文字列
note.text	コメントテキスト。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.href	空の文字列を返します。データタイプ：文字列
relatedEntity.name	影響を受けるアイテムまたはサービスの名前。データタイプ：文字列
relatedEntity.role	影響を受けるアイテムまたはサービスの説明。データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
relatedEntity.@type	この値は常に `relatedEntity` です。データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。チケットタイプと関係者タイプに応じて、次のテーブルからsys_idできます。ケース: アカウント [customer_account];関係者タイプは`顧客`です連絡先 [customer_contact];関係者タイプが `customer_contact` インシデント: 会社 [core_company];関係者タイプは`顧客`ですユーザー [sys_user];関係者タイプが `customer_contact` ケースまたはインシデント: グループ [sys_user_group];関係者タイプが `assignment_group` ユーザー [sys_user];関係者タイプが `assigned_to` データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.@referredType	関係者のタイプ。可能な値： `assigned_to`:チケットの作業をアサインされたユーザー。 `assignment_group`:チケットの作業にアサインされたグループ。 `顧客`:チケットの会社またはアカウント。 `customer_contact`:チケットの発信者または連絡先。データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。[優先度] フィールドにマップします。データタイプ：文字列
status	トラブルチケットの現在のステータス。[ステータス] フィールドにマッピングします。データタイプ：文字列
チケットタイプ	チケットのタイプ。可能な値：ケースインシデントサービスの問題ケースデータタイプ：文字列
@type	この値は常に `TroubleTicket` です。データタイプ：文字列

cURL 要求

この例では、ケース [sn_customerservice_case] テーブルからトラブルチケットレコードを取得します。

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

{
    "id": "370415f03c20e910f8772f1bc332b31b",
    "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/370415f03c20e910f8772f1bc332b31b",
    "creationDate": "2023-01-19 22:39:28",
    "lastUpdate": "2023-01-19 22:41:39",
    "description": "Router is not working, my devices cannot detect any signals from the router. First button from the left is flashing red, all others are black. Resetting the router does not solve the problem, I need urgent assistance.",
    "severity": "2 - High",
    "ticketType": "Case",
    "name": "My router is not working properly",
    "status": "Open",
    "channel": {
        "name": "e_bonding"
    },
    "relatedParty": [
        {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@referredType": "customer"
        },
        {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@referredType": "customer_contact"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assignment_group"
        },
        {
            "id": "",
            "name": "",
            "@referredType": "assigned_to"
        }
    ],
    "relatedEntity": [
        {
            "id": "b7fa12c7532520103b6bddeeff7b123b",
            "href": "",
            "name": "Deduplication and Compression PRD00001965",
            "role": "This is the product associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product"
        },
        {
            "id": "71e73d87c3e23010ff00ed23a140dde8",
            "href": "",
            "name": "",
            "role": "This is the asset associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "asset"
        },
        {
            "id": "a1913c3577b301108e191e599a5a99e8",
            "href": "",
            "name": "Deduplication and Compression PI0000037",
            "role": "This is the product inventory associated with the case.",
            "@type": "relatedEntity",
            "@referredType": "product_inventory"
        }
    ],
    "note": [
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:41:39",
            "author": "System Administrator",
            "@type": "comments"
        },
        {
            "text": "This is a testing comment<script>gs.info('Hello World')</script>",
            "date": "2023-01-19 14:39:28",
            "author": "System Administrator",
            "@type": "comments"
        }
    ],
    "@type": "TroubleTicket"
}

トラブルチケット:PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

ケース [sn_customerservice_case]、インシデント [incident]、またはサービス問題ケース [sn_sprb_mgmt_case] テーブルの指定されたレコードを更新します。

URL 形式

デフォルト URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket/{id}

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
ID	更新するケースまたはインシデントレコードのSys_id。データタイプ：文字列テーブル:ケース [sn_customerservice_case] またはインシデント [incident]

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (JSON)
名前	説明
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマッピングします。有効な値は、contact_typeフィールドの選択肢です。選択肢のラベルまたは値を指定できます。たとえば、 `仮想エージェント` や `virtual_agent`などです。データタイプ：文字列
description	問題の説明。[ 説明] フィールドにマッピングします。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。[簡単な説明] フィールドにマッピングします。データタイプ：文字列
注意	チケットに追加する作業メモとコメントのリスト。データタイプ：オブジェクトのアレイ `"note":[ { "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。この値は、メモが [作業メモ] フィールドまたは [追加コメント] フィールドに記録されるかどうかを決定します。有効な値：コメント work_notes データタイプ：文字列
note.text	メモテキスト。[作業メモ] または [追加コメント] フィールドにマッピングします。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "@referredType": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。場合によっては、このパラメーターは [連絡先] または [アカウント] フィールドに入力されます。インシデントの場合、このパラメーターは [問い合わせユーザー] または [会社] フィールドに入力されます。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。連絡先またはユーザー (発信者) を指定すると、その連絡先またはユーザーのアカウントまたは会社がチケットに自動的に入力されます。データタイプ：文字列テーブル:場合によっては、連絡先 [customer_contact] テーブルまたはアカウント [customer_account] テーブルからのsys_idです。インシデントの場合、sys_idはユーザー [sys_user] テーブルまたは会社 [core_company] テーブルから取得されます。
relatedParty.@referredType	関係者のタイプ。有効な値：顧客:チケットの会社またはアカウント。 customer_contact:チケットの問い合わせユーザーまたは連絡先。データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。[ 優先度] フィールドにマップします。有効な値： 1:重大 2:高 3:中 4:低 5:計画。インシデントのみ。有効な値は、[優先度] フィールドの選択肢です。選択値のみを指定する必要があります。例では、`1`。無効な値を指定すると、重大度は低に設定されます。データタイプ：文字列
status	トラブルチケットの現在のステータス。[ ステータス ] フィールドにマッピングします。有効な値は、[ ステータス ] フィールドの選択肢です。選択肢のラベルまたは値を指定できます。たとえば、[ `新規]` や `[1`] などです。データタイプ：文字列

ヘッダー

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求が正しくありません。次の 1 つ以上の理由で、不正な要求タイプまたは誤った形式の要求が検出されました。パスパラメーターが無効です。無効な URI。
404	レコードが見つかりません。ID に関連付けられたレコードがケース [sn_customerservice_case] またはインシデント [incident] テーブルに見つかりません。

応答本文のパラメーター (JSON)


名前	説明
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。データタイプ：文字列
creationDate	レコードが作成された日付。データタイプ：文字列
description	チケットからの問題の説明。データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。データタイプ：文字列
ID	ケースまたはインシデントレコードのSys_id。データタイプ：文字列
前回の更新	レコードが最後に更新された日付。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。データタイプ：文字列
注意	チケットに関するすべてのコメントのリスト。このリストには作業メモは含まれません。データタイプ：オブジェクトのアレイ `"note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。コメントのみが返されるため (作業メモは返されません)、この値は常に `コメント`です。データタイプ：文字列
note.author	コメントを作成したユーザーの名前。データタイプ：文字列
note.date	ServiceNowインスタンスでコメントが作成された日付。データタイプ：文字列
note.text	コメントテキスト。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.href	空の文字列を返します。データタイプ：文字列
relatedEntity.name	影響を受けるアイテムまたはサービスの名前。データタイプ：文字列
relatedEntity.role	影響を受けるアイテムまたはサービスの説明。データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
relatedEntity.@type	この値は常に `relatedEntity` です。データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。チケットタイプと関係者タイプに応じて、次のテーブルからsys_idできます。ケース: アカウント [customer_account];関係者タイプは`顧客`です連絡先 [customer_contact];関係者タイプが `customer_contact` インシデント: 会社 [core_company];関係者タイプは`顧客`ですユーザー [sys_user];関係者タイプが `customer_contact` ケースまたはインシデント: グループ [sys_user_group];関係者タイプが `assignment_group` ユーザー [sys_user];関係者タイプが `assigned_to` データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.@referredType	関係者のタイプ。可能な値： `assigned_to`:チケットの作業をアサインされたユーザー。 `assignment_group`:チケットの作業にアサインされたグループ。 `顧客`:チケットの会社またはアカウント。 `customer_contact`:チケットの発信者または連絡先。データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。データタイプ：文字列
status	トラブルチケットの現在のステータス。データタイプ：文字列
チケットタイプ	チケットのタイプ。可能な値：ケースインシデントサービスの問題ケースデータタイプ：文字列
@type	この値は常に `TroubleTicket` です。データタイプ：文字列

cURL 要求

この例では、ケースレコードを更新します。

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   description: "Updated description",
   "note": [
      {
         "text": "Adding another comment",
         "@type": "comments"
      }
   ]
}" \
--user 'username':'password'

応答本文。

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:48:42",
   "description": "Updated description",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Adding another comment",
         "date": "2022-05-16 16:48:42",
         "author": "admin",
         "@type": "comments"
      },
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}

トラブルチケット:POST /sn_ind_tsm_sdwan/ticket/troubleTicket

ケース [sn_customerservice_case]、インシデント [incident]、またはサービス問題ケース [sn_sprb_mgmt_case] テーブルにレコードを作成します。

URL 形式

デフォルト URL: /api/sn_ind_tsm_sdwan/ticket/troubleTicket

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
なし

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)
名前	説明
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマッピングします。有効な値は、contact_typeフィールドの選択肢です。選択肢のラベルまたは値を指定できます。たとえば、 `仮想エージェント` や `virtual_agent`などです。データタイプ：文字列
description	必須です。問題の説明。[ 説明] フィールドにマッピングします。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。[簡単な説明] フィールドにマッピングします。データタイプ：文字列
注意	チケットに追加する作業メモとコメントのリスト。データタイプ：オブジェクトのアレイ `"note":[ { "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。この値は、メモが [作業メモ] フィールドまたは [追加コメント] フィールドに記録されるかどうかを決定します。有効な値：コメント work_notes データタイプ：文字列
note.text	メモテキスト。[作業メモ] または [追加コメント] フィールドにマッピングします。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "@referredType": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。場合によっては、このパラメーターは [連絡先] または [アカウント] フィールドに入力されます。インシデントの場合、このパラメーターは [問い合わせユーザー] または [会社] フィールドに入力されます。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。連絡先またはユーザー (発信者) を指定すると、その連絡先またはユーザーのアカウントまたは会社がチケットに自動的に入力されます。データタイプ：文字列テーブル:場合によっては、連絡先 [customer_contact] テーブルまたはアカウント [customer_account] テーブルからのsys_idです。インシデントの場合、sys_idはユーザー [sys_user] テーブルまたは会社 [core_company] テーブルから取得されます。
relatedParty.@referredType	関係者のタイプ。有効な値：顧客:チケットの会社またはアカウント。 customer_contact:チケットの問い合わせユーザーまたは連絡先。データタイプ：文字列
severity	必須です。トラブルチケットで説明されている問題の重大度。[ 優先度] フィールドにマップします。有効な値： 1:重大 2:高 3:中 4:低 5:計画。インシデントのみ。有効な値は、[優先度] フィールドの選択肢です。選択値のみを指定する必要があります。例では、`1`。無効な値を指定すると、重大度は低に設定されます。データタイプ：文字列
status	必須です。トラブルチケットの現在のステータス。[ ステータス ] フィールドにマッピングします。有効な値は、[ ステータス ] フィールドの選択肢です。選択肢のラベルまたは値を指定できます。たとえば、[ `新規]` や `[1`] などです。無効な値を指定すると、ステータスは [新規] に設定されます。データタイプ：文字列
チケットタイプ	チケットのタイプ。この値は、レコードがケース [sn_customerservice_case]、インシデント [incident]、またはサービス問題ケース [sn_sprb_mgmt_case] テーブルのいずれで作成されるかを決定します。有効な値：ケースインシデントサービスの問題ケースデータタイプ：文字列デフォルト:インシデント

ヘッダー

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
Content-Type	要求本文のデータ形式。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

表 : 24. ステータスコード
ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。次の 1 つ以上の理由で、不正な要求タイプまたは誤った形式の要求が検出されました。空のペイロード。無効なペイロードです。必須フィールドがありません。 ticketType が無効です。

応答本文のパラメーター (JSON)


名前	説明
@type	この値は常に `TroubleTicket` です。データタイプ：文字列
チャネル	チケットの作成に使用された連絡方法。データタイプ: オブジェクト `"channel":{ "name": "String" }`
channel.name	連絡方法の名前。データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。データタイプ：文字列
description	チケットの問題の説明。データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。データタイプ：文字列
ID	作成されたケースまたはインシデントレコードのsys_id。データタイプ：文字列
前回の更新	ケースまたはインシデントレコードが最後に更新された日付。データタイプ：文字列
name	トラブルチケットの名前。通常は問題の簡単な説明です。データタイプ：文字列
注意	チケットに関するすべてのコメントのリスト。このリストには作業メモは含まれません。データタイプ：アレイ `"note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]`
note.@type	メモのタイプ。コメントのみが返されるため (作業メモは返されません)、この値は常に `コメント`です。データタイプ：文字列
note.author	コメントを書いたユーザーの名前。データタイプ：文字列
note.date	ServiceNowインスタンスでコメントが作成された日付。データタイプ：文字列
note.text	コメントテキスト。データタイプ：文字列
relatedEntity	影響を受ける資産、製品、販売済み製品 (製品インベントリ)、構成アイテム、またはサービスのリスト。データタイプ：オブジェクトのアレイ `"relatedEntity": [ { "id": "String", "href": "String", "name": "String", "role": "String", "@referredType": "String", "@type": "String" } ]`
relatedEntity.id	影響を受けるアイテムまたはサービスのSys_id。場合によっては、この値は次のいずれかのテーブルから取得されます。資産 [alm_asset] 製品インベントリ [sn_prd_invt_product_inventory]。販売済み製品 [sn_install_base_sold_product] テーブルを拡張します。製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] インシデントの場合、この値は次のいずれかのテーブルから取得されます。構成アイテム (CI) [cmdb_ci] サービス [cmdb_ci_service] データタイプ：文字列
relatedEntity.href	空の文字列を返します。データタイプ：文字列
relatedEntity.name	影響を受けるアイテムまたはサービスの名前。データタイプ：文字列
relatedEntity.role	影響を受けるアイテムまたはサービスの説明。データタイプ：文字列
relatedEntity.@referredType	アイテムまたはサービスのタイプ。ケースチケットの有効な値: 資産 product product_inventory インシデントチケットの有効な値: cmdb_ci cmdb_ci_service データタイプ：文字列
relatedEntity.@type	この値は常に `relatedEntity` です。データタイプ：文字列
関連パーティー	チケットの連絡先に関する詳細。データタイプ：オブジェクトのアレイ `"relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]`
relatedParty.id	関係者の sys_id。チケットタイプと関係者タイプに応じて、次のテーブルからsys_idできます。ケース: アカウント [customer_account];関係者タイプは`顧客`です連絡先 [customer_contact];関係者タイプが `customer_contact` インシデント: 会社 [core_company];関係者タイプは`顧客`ですユーザー [sys_user];関係者タイプが `customer_contact` ケースまたはインシデント: グループ [sys_user_group];関係者タイプが `assignment_group` ユーザー [sys_user];関係者タイプが `assigned_to` データタイプ：文字列
relatedParty.name	関係者の名前。データタイプ：文字列
relatedParty.@referredType	関係者のタイプ。可能な値： `assigned_to`:チケットの作業をアサインされたユーザー。 `assignment_group`:チケットの作業にアサインされたグループ。 `顧客`:チケットの会社またはアカウント。 `customer_contact`:チケットの発信者または連絡先。データタイプ：文字列
severity	トラブルチケットで説明されている問題の重大度。データタイプ：文字列
status	トラブルチケットの現在のステータス。データタイプ：文字列
チケットタイプ	チケットのタイプ。可能な値：ケースインシデントサービスの問題ケースデータタイプ：文字列

cURL 要求

この例では、トラブルチケットケースレコードを作成します。

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/ticket/troubleTicket" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "name": "Laptop problem",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2",
   "status": "New",
   "ticketType": "Case",
   "channel": {
      "name": "Web"
   },
   "note": [
      {
         "text": "Work note about this case",
         "@type": "work_notes"
      },
      {
         "text": "Comment about this case",
         "@type": "comments"
      }
   ],
   "relatedEntity": [
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "@referredType": "asset"
      }
   ],
   "relatedParty": [
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "@referredType": "customer_contact"
      }
   ]
}" \
--user 'username':'password'

応答本文。

{
   "id": "6467508d47e345508761b955d36d43f6",
   "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/6467508d47e345508761b955d36d43f6",
   "creationDate": "2022-05-16 23:38:55",
   "lastUpdate": "2022-05-16 23:38:55",
   "description": "Laptop keeps shutting off unexpectedly",
   "severity": "2 - High",
   "ticketType": "Case",
   "name": "Laptop problem",
   "status": "New",
   "channel": {
      "name": "web"
   },
   "relatedParty": [
      {
         "id": "",
         "name": "",
         "@referredType": "customer"
      },
      {
         "id": "62826bf03710200044e0bfc8bcbe5df1",
         "name": "",
         "@referredType": "customer_contact"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assignment_group"
      },
      {
         "id": "",
         "name": "",
         "@referredType": "assigned_to"
      }
   ],
   "relatedEntity": [
      {
         "id": "",
         "href": "",
         "name": "",
         "role": "This is the product associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product"
      },
      {
         "id": "74a9ec0d3790200044e0bfc8bcbe5d7f",
         "href": "",
         "name": "P1000597 - Apple MacBook Pro 15\"",
         "role": "This is the asset associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "asset"
      }
      {
         "id": "a1913c3577b301108e191e599a5a99e8",
         "href": "",
         "name": "Deduplication and Compression PI0000037",
         "role": "This is the product inventory associated with the case.",
         "@type": "relatedEntity",
         "@referredType": "product_inventory"
      }
   ],
   "note": [
      {
         "text": "Comment about this case",
         "date": "2022-05-16 16:38:55",
         "author": "admin",
         "@type": "comments"
      }
   ],
   "@type": "TroubleTicket"
}