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

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

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

この API は、ServiceNow Store で利用可能な電気通信保証ワークフローアプリケーションに含まれています。この API をケース [sn_customerservice_case] テーブルとともに使用するには、カスタマーサービス (com.sn_customerservice) および Customer Service Install Base Management (com.snc.install_base) アプリケーションが必要です。

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

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

この API を拡張して、必要なパラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングに関するカスタマイズを実行できます。詳細については、次を参照してください：トラブルチケットオープンAPI開発者ガイドを参照してください。

トラブルチケットオープン API は、TM Forum Trouble Ticket Management API REST 仕様の ServiceNow® 実装です。この実装は、TMF621 Trouble Ticket Management API REST Specification Release 19 (2019 年 6 月) に基づいています。トラブルチケットオープン API は、TM Forum によって適合性が認定されています。

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

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

URL 形式

デフォルトの URL：/api/sn_ind_tsm_sdwan/ticket/troubleTicket

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

表 : 1. パスパラメーター

名前	説明
なし

表 : 2. クエリパラメータ

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効なフィールド： channel creationDate 説明 href id lastUpdate name note relatedEntity relatedParty severity status ticketType @type デフォルト：すべてのフィールドを返します。 データタイプ：文字列
id	トラブルチケットを sys_id でフィルタリングします。指定された sys_id のチケットのみが応答で返されます。 データタイプ：文字列
limit	返されるレコードの最大数。このレコード数を超える要求の場合は、offset パラメーターを使用してレコード取得をページネーションします。 デフォルト：25 最大：100 デフォルト値と最大値を変更するには、sn_ind_tsm_sdwan.pagination.set_limit および sn_ind_tsm_sdwan.pagination.max_limit システムプロパティを更新します。 データタイプ：数値
offset	レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。 デフォルト：0 データタイプ：数値
severity	トラブルチケットを重大度でフィルタリングします。指定された重大度のチケットのみが応答で返されます。 データタイプ：文字列
status	トラブルチケットをステータスでフィルタリングします。指定されたステータスのチケットのみが応答で返されます。 データタイプ：文字列
ticketType	トラブルチケットをチケットタイプでフィルタリングします。指定されたタイプのチケットのみが応答で返されます。 有効な値： ケース インシデント データタイプ：文字列

表 : 3. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 4. 要求ヘッダー

ヘッダー	説明
なし

表 : 5. 応答ヘッダー

ヘッダー	説明
Content-Range	ページネーションされた呼び出しで返されるコンテンツの範囲を指定します。 たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値は items 3-5 です。
Content-Type	応答本文のデータフォーマット。application/json のみをサポートします。
Link	クエリー結果内を移動するための次のリンクが含まれています。 first last next previous
X-Total-Count	ページネーションされたクエリの場合、このヘッダーはサーバーで利用可能なレコードの合計数を指定します。

ステータスコード

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

表 : 6. ステータスコード

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

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

名前	説明
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマップされます。 データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。[作成日時] フィールドにマップされます。 データタイプ：文字列
説明	チケットの問題の説明。[説明] フィールドにマップされます。 データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。 データタイプ：文字列
id	ケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	レコードが最後に更新された日付。[更新日時] フィールドにマップされます。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。[簡単な説明] フィールドにマップされます。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	関係者の sys_id。sys_id は、チケットタイプと関係者タイプに応じて、次のテーブルから取得できます。 ケース： アカウント [customer_account] - 関係者タイプは customer です。 連絡先 [customer_contact] - 関係者タイプは customer_contact です。 インシデント： 会社 [core_company] - 関係者タイプは customer です。 ユーザー [sys_user] - 関係者タイプは customer_contact です。 ケースまたはインシデント： グループ [sys_user_group] - 関係者タイプは assignment_group です。 ユーザー [sys_user] - 関係者タイプは assigned_to です。 データタイプ：文字列
relatedParty.name	関係者の名前。 データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。 可能な値： assigned_to：チケットの作業にアサインされたユーザー。 assignment_group：チケットの作業にアサインされたグループ。 customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。[優先度] フィールドにマップされます。 データタイプ：文字列
status	トラブルチケットの現在のステータス。[ステータス] フィールドにマップされます。 データタイプ：文字列
ticketType	チケットのタイプ。 可能な値： ケース インシデント データタイプ：文字列
@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] テーブルから取得します。

URL 形式

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

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

表 : 7. パスパラメーター

名前	説明
id	取得するケースまたはインシデントレコードの sys_id。ケース [sn_customerservice_case] またはインシデント [incident] テーブルにあります。 データタイプ：文字列

表 : 8. クエリパラメーター

名前	説明
fields	応答で返すフィールドのリスト。無効なフィールドは無視されます。 有効な値： channel creationDate 説明 href id lastUpdate name note relatedEntity relatedParty severity status ticketType @type デフォルト：すべてのフィールドを返します。 データタイプ：文字列

表 : 9. 要求本文パラメーター (JSON)

名前	説明
なし

ヘッダー

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

表 : 10. 要求ヘッダー

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

表 : 11. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 12. ステータスコード

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

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

名前	説明
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマップされます。 データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。[作成日時] フィールドにマップされます。 データタイプ：文字列
説明	チケットの問題の説明。[説明] フィールドにマップされます。 データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。 データタイプ：文字列
id	ケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	レコードが最後に更新された日付。[更新日時] フィールドにマップされます。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。[簡単な説明] フィールドにマップされます。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	関係者の sys_id。sys_id は、チケットタイプと関係者タイプに応じて、次のテーブルから取得できます。 ケース： アカウント [customer_account] - 関係者タイプは customer です。 連絡先 [customer_contact] - 関係者タイプは customer_contact です。 インシデント： 会社 [core_company] - 関係者タイプは customer です。 ユーザー [sys_user] - 関係者タイプは customer_contact です。 ケースまたはインシデント： グループ [sys_user_group] - 関係者タイプは assignment_group です。 ユーザー [sys_user] - 関係者タイプは assigned_to です。 データタイプ：文字列
relatedParty.name	関係者の名前。 データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。 可能な値： assigned_to：チケットの作業にアサインされたユーザー。 assignment_group：チケットの作業にアサインされたグループ。 customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。[優先度] フィールドにマップされます。 データタイプ：文字列
status	トラブルチケットの現在のステータス。[ステータス] フィールドにマップされます。 データタイプ：文字列
ticketType	チケットのタイプ。 可能な値： ケース インシデント データタイプ：文字列
@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"
}

トラブルチケット - GET /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

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

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは トラブルチケット - GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id} です。

URL 形式

デフォルトの URL：/api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

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

表 : 13. パスパラメーター

名前	説明
ticketType	チケットのタイプ。この値は、レコードをケース [sn_customerservice_case] またはインシデント [incident] テーブルから取得するかどうかを決定します。 有効な値： case incident データタイプ：文字列
id	取得するケースまたはインシデントレコードの sys_id。 データタイプ：文字列

表 : 14. クエリパラメーター

名前	説明
fields	応答で返すカンマ区切りのフィールドのリストです。無効なフィールドは無視されます。この値が渡されない場合は、すべてのフィールドが返されます。 有効なフィールド： channel creationDate 説明 id lastUpdate name note relatedEntity relatedParty severity status ticketType @type データタイプ：文字列

表 : 15. 要求本文パラメーター (XML または JSON)

名前	説明
なし

ヘッダー

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

表 : 16. 要求ヘッダー

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

表 : 17. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 18. ステータスコード

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

応答本文のパラメーター (JSON または XML)

名前	説明
@type	この値は常に TroubleTicket です。 データタイプ：文字列
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。ケースのチャネル [contact_type] フィールドとインシデントの連絡先タイプ [contact_type] フィールドにマップされます。 データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。[作成日時] フィールドにマップされます。 データタイプ：文字列
説明	チケットの問題の説明。[説明] フィールドにマップされます。 データタイプ：文字列
id	ケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	レコードが最後に更新された日付。[更新日時] フィールドにマップされます。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。[簡単な説明] フィールドにマップされます。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットに関連付けられている会社と連絡先の詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。 有効な値： customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
relatedParty.id	関係者の sys_id。ケースの場合、sys_id は、連絡先 [customer_contact] またはアカウント [customer_account] テーブルからのものです。インシデントの場合、sys_id は、ユーザー [sys_user] または会社 [core_company] テーブルからのものです。連絡先またはユーザー (問い合わせユーザー) を指定すると、そのアカウントまたは会社が自動的にチケットに入力されます。 データタイプ：文字列
relatedParty.name	関係者の名前。ケースの場合は、[連絡先] または [アカウント] フィールドにマップされます。インシデントの場合は、[問い合わせユーザー] または [会社] フィールドにマップされます。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。[優先度] フィールドにマップされます。 データタイプ：文字列
status	トラブルチケットの現在のステータス。[ステータス] フィールドにマップされます。 データタイプ：文字列
ticketType	チケットのタイプ (ケースまたはインシデント)。 データタイプ：文字列

cURL 要求

この例では、ケースの名前、説明、重大度、およびステータスを取得します。

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/a78e2c8cdb68b41015364c9b0b96193e?fields=name%2Cdescription%2Cseverity%2Cstatus" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

応答本文。

{
  "name": "Short description of issue",
  "description": "Example description of an issue",
  "severity": "2 - High",
  "status": "Open"
}

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

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

URL 形式

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

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

表 : 19. パスパラメーター

名前	説明
id	更新するケースまたはインシデントレコードの sys_id。ケース [sn_customerservice_case] またはインシデント [incident] テーブルにあります。 データタイプ：文字列

表 : 20. クエリパラメーター

名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)

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

ヘッダー

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

表 : 22. 要求ヘッダー

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

表 : 23. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 24. ステータスコード

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

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

名前	説明
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。 データタイプ：文字列
creationDate	レコードが作成された日付。 データタイプ：文字列
説明	チケットの問題の説明。 データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。 データタイプ：文字列
id	ケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	レコードが最後に更新された日付。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	関係者の sys_id。sys_id は、チケットタイプと関係者タイプに応じて、次のテーブルから取得できます。 ケース： アカウント [customer_account] - 関係者タイプは customer です。 連絡先 [customer_contact] - 関係者タイプは customer_contact です。 インシデント： 会社 [core_company] - 関係者タイプは customer です。 ユーザー [sys_user] - 関係者タイプは customer_contact です。 ケースまたはインシデント： グループ [sys_user_group] - 関係者タイプは assignment_group です。 ユーザー [sys_user] - 関係者タイプは assigned_to です。 データタイプ：文字列
relatedParty.name	関係者の名前。 データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。 可能な値： assigned_to：チケットの作業にアサインされたユーザー。 assignment_group：チケットの作業にアサインされたグループ。 customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。 データタイプ：文字列
status	トラブルチケットの現在のステータス。 データタイプ：文字列
ticketType	チケットのタイプ。 可能な値： ケース インシデント データタイプ：文字列
@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"
}

トラブルチケット - PATCH /sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

ケース [sn_customerservice_case] またはインシデント [incident] テーブル内のレコードを更新します。

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは トラブルチケット - PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id} です。

URL 形式

デフォルトの URL：/api/sn_ind_tsm_sdwan/troubleticket/{ticketType}/{id}

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

表 : 25. パスパラメーター

名前	説明
ticketType	チケットのタイプ。この値は、ケース [sn_customerservice_case] またはインシデント [incident] テーブルでレコードを更新するかどうかを決定します。 有効な値： case incident データタイプ：文字列
id	更新するケースまたはインシデントレコードの sys_id。 データタイプ：文字列

表 : 26. クエリパラメーター

名前	説明
なし

表 : 27. 要求本文パラメーター (XML または JSON)

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

ヘッダー

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

表 : 28. 要求ヘッダー

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

表 : 29. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 30. ステータスコード

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

応答本文のパラメーター (JSON または XML)

名前	説明
@type	この値は常に TroubleTicket です。 データタイプ：文字列
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。 データタイプ：文字列
creationDate	レコードが作成された日付。 データタイプ：文字列
説明	チケットの問題の説明。 データタイプ：文字列
id	ケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	レコードが最後に更新された日付。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットに関連付けられている会社と連絡先の詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.@referredType	関連するパーティのタイプ。 有効な値： customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
relatedParty.id	関係者の sys_id。ケースの場合、sys_id は、連絡先 [customer_contact] またはアカウント [customer_account] テーブルからのものです。インシデントの場合、sys_id は、ユーザー [sys_user] または会社 [core_company] テーブルからのものです。連絡先またはユーザー (問い合わせユーザー) を指定すると、そのアカウントまたは会社が自動的にチケットに入力されます。 データタイプ：文字列
relatedParty.name	関係者の名前。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。 データタイプ：文字列
status	トラブルチケットの現在のステータス。 データタイプ：文字列
ticketType	チケットのタイプ (ケースまたはインシデント)。 データタイプ：文字列

cURL 要求

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

curl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case/370415f03c20e910f8772f1bc332b31b" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"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.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--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"
}

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

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

URL 形式

デフォルトの URL：/api/sn_ind_tsm_sdwan/ticket/troubleTicket

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

表 : 31. パスパラメーター

名前	説明
なし

表 : 32. クエリパラメータ

名前	説明
なし

表 : 33. 要求本文パラメーター (JSON)

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

ヘッダー

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

表 : 34. 要求ヘッダー

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

表 : 35. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 36. ステータスコード

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

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

名前	説明
@type	この値は常に TroubleTicket です。 データタイプ：文字列
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。 データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。 データタイプ：文字列
説明	チケットの問題の説明。 データタイプ：文字列
href	ケースまたはインシデントレコードへの相対リンク。 データタイプ：文字列
id	作成されたケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	ケースまたはインシデントレコードが最後に更新された日付。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。 データタイプ：文字列
note	チケットのすべてのコメントのリスト。このリストには作業メモは含まれません。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。(作業メモではなく) コメントのみが返されるため、この値は常に comments です。 データタイプ：文字列
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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットの連絡先に関する詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "name": "String", "@referredType": "String" } ]
relatedParty.id	関係者の sys_id。sys_id は、チケットタイプと関係者タイプに応じて、次のテーブルから取得できます。 ケース： アカウント [customer_account] - 関係者タイプは customer です。 連絡先 [customer_contact] - 関係者タイプは customer_contact です。 インシデント： 会社 [core_company] - 関係者タイプは customer です。 ユーザー [sys_user] - 関係者タイプは customer_contact です。 ケースまたはインシデント： グループ [sys_user_group] - 関係者タイプは assignment_group です。 ユーザー [sys_user] - 関係者タイプは assigned_to です。 データタイプ：文字列
relatedParty.name	関係者の名前。 データタイプ：文字列
relatedParty.@referredType	関連するパーティのタイプ。 可能な値： assigned_to：チケットの作業にアサインされたユーザー。 assignment_group：チケットの作業にアサインされたグループ。 customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。 データタイプ：文字列
status	トラブルチケットの現在のステータス。 データタイプ：文字列
ticketType	チケットのタイプ。 可能な値： ケース インシデント データタイプ：文字列

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"
}

トラブルチケット - POST /sn_ind_tsm_sdwan/troubleticket/{ticketType}

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

重要:

Tokyo リリース以降、このエンドポイントは廃止されました。このエンドポイントの新しいバージョンは トラブルチケット - POST /sn_ind_tsm_sdwan/ticket/troubleTicket  です。

URL 形式

デフォルトの URL：/api/sn_ind_tsm_sdwan/troubleticket/{ticketType}

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

表 : 37. パスパラメーター

名前	説明
ticketType	チケットのタイプ。この値は、ケース [sn_customerservice_case] またはインシデント [incident] テーブルにレコードを作成するかどうかを決定します。 有効な値： case incident データタイプ：文字列

表 : 38. クエリパラメーター

名前	説明
なし

表 : 39. 要求本文パラメーター (XML または JSON)

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

ヘッダー

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

表 : 40. 要求ヘッダー

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

表 : 41. 応答ヘッダー

ヘッダー	説明
なし

ステータスコード

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

表 : 42. ステータスコード

ステータスコード	説明
201	成功。要求が正常に処理されました。
400	要求が正しくありません。次の理由のうち 1 つ以上で、不適切な要求タイプまたは誤った形式の要求が検出されました。 空のペイロード。 無効なペイロード。必須フィールドがありません。 ticketType が無効であるか、または ticketType がパスパラメーター ticketType と一致しません。たとえば、ticketType は case ですが、パスパラメーターは incident です。

応答本文のパラメーター (JSON または XML)

名前	説明
@type	この値は常に TroubleTicket です。 データタイプ：文字列
channel	チケットの作成に使用された連絡方法。 データタイプ：オブジェクト "channel":{ "name": "String" }
channel.name	連絡方法の名前。 データタイプ：文字列
creationDate	ケースまたはインシデントレコードが作成された日付。 データタイプ：文字列
説明	チケットの問題の説明。 データタイプ：文字列
id	作成されたケースまたはインシデントレコードの sys_id。 データタイプ：文字列
lastUpdate	ケースまたはインシデントレコードが最後に更新された日付。 データタイプ：文字列
name	トラブルチケットの名前 (通常は問題の簡単な説明)。 データタイプ：文字列
note	POST 要求によってチケットに追加されたコメントと作業メモのリスト。 データタイプ：アレイ "note":[ { "author": "String", "date": "String", "text": "String", "@type": "String" } ]
note.@type	メモのタイプ。 有効な値： work_notes comments データタイプ：文字列
note.author	メモを作成した POST 要求を行った 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] 製品モデル [cmdb_model] 販売済み製品 [sn_install_base_sold_product] 製品インベントリ [sn_prd_invt_product_inventory] は、販売済み製品 [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	チケットに関連付けられている会社と連絡先の詳細。 データタイプ：アレイ "relatedParty": [ { "id": "String", "@referredType": "String" } ]
relatedParty.id	関係者の sys_id。ケースの場合、sys_id は、連絡先 [customer_contact] またはアカウント [customer_account] テーブルからのものです。インシデントの場合、sys_id は、ユーザー [sys_user] または会社 [core_company] テーブルからのものです。連絡先またはユーザー (問い合わせユーザー) を指定すると、そのアカウントまたは会社が自動的にチケットに入力されます。 データタイプ：文字列
relatedParty.referredType	関連するパーティのタイプ。 有効な値： customer：チケットの会社またはアカウント。 customer_contact：チケットの問い合わせユーザーまたは連絡先。 データタイプ：文字列
severity	トラブルチケットに記載されている問題の重大度。 データタイプ：文字列
status	トラブルチケットの現在のステータス。 データタイプ：文字列
ticketType	チケットのタイプ (ケースまたはインシデント)。 データタイプ：文字列

cURL 要求

この例では、優先度が高くオープンステータスのケースを作成します。

ccurl "https://instance.servicenow.com/api/sn_ind_tsm_sdwan/troubleticket/case" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"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.\",
    \"name\":\"My router is not working properly\",
    \"severity\":\"2\",
    \"status\":\"10\",
    \"ticketType\":\"Case\",
    \"channel\":{
        \"id\":\"8774\",
        \"name\":\"eBonding\",
        \"@type\":\"Channel\"
    },
    \"note\":[
        {
            \"id\":\"77456\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:34:45.968Z\",
            \"text\":\"This is a testing work note<html>hello world</html> and <h1>title</h1>\",
            \"@type\":\"Worknotes\"
        },
        {
            \"id\":\"77457\",
            \"author\":\"Jack Smith\",
            \"date\":\"2019-05-31T07:35:45.968Z\",
            \"text\":\"This is a testing comment<script>gs.info('Hello World')</script>\",
            \"@type\":\"Comment\"
        }
    ],
    \"relatedParty\":[
        {
            \"id\":\"eaf68911c35420105252716b7d40ddde\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v1/individual/9866\",
            \"name\":\"Sally Thomas\",
            \"role\":\"customer\",
            \"@referredType\":\"customer_contact\"
        },
        {
            \"id\":\"ffc68911c35420105252716b7d40dd55\",
            \"href\":\"https://mycsp.com:8080/tmf-api/partyManagement/v4/customer/9176\",
            \"name\":\"Funco Intl\",
            \"role\":\"customer\",
            \"@referredType\":\"customer\"
        }
    ],
    \"relatedEntity\": [
        {
            \"id\": \"b7fa12c7532520103b6bddeeff7b123b\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product\"
        },
        {
            \"id\": \"71e73d87c3e23010ff00ed23a140dde8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"asset\"
        },
        {
            \"id\": \"a1913c3577b301108e191e599a5a99e8\",
            \"href\": \"www.google.com\",
            \"name\": \"Some random name\",
            \"role\": \"I dont know what this is\",
            \"@type\": \"relatedEntity\",
            \"@referredType\": \"product_inventory\"
        }
    ]
}" \
--user 'username':'password'

応答本文。

{
  "id": "5bbb5cbc3c2ca910f8772f1bc332b34d",
  "href": "/api/sn_ind_tsm_sdwan/ticket/troubleTicket/5bbb5cbc3c2ca910f8772f1bc332b34d",
  "creationDate": "2023-01-19 18:33:24",
  "lastUpdate": "2023-01-19 18:33:24",
  "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 10:33:24",
      "author": "System Administrator",
      "@type": "comments"
    }
  ],
  "@type": "TroubleTicket"
}