--- 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 --- # SAM-ソフトウェア使用状況データ統合 API # SAM-ソフトウェア使用状況データ統合 API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：9分 SAM-ソフトウェア使用状況データ統合 API は、ソフトウェア使用状況 \[samp_sw_usage\] テーブルのレコードを作成および更新するためのエンドポイントを提供します。この API では、Software Asset Management Professional (com.snc.samp) プラグインを有効にする必要があります。また、このエンドポイントにアクセスするには、sam_admin または sam_developer ロールも必要です。 ## SAM-ソフトウェア使用状況データ統合 - POST /sam_software_usage_integration/createOrUpdate {#ariaid-title2} ソフトウェア使用状況 \[samp_sw_usage\] テーブル内の指定されたレコードを作成または更新します。 1 回の呼び出しで 1 つ以上のソフトウェア使用状況レコードを作成/更新できます。 ### URL 形式バージョニングされた URL：/api/now/{api_version}/sam_software_usage_integration/createOrUpdate デフォルトの URL：/api/now/sam_software_usage_integration/createOrUpdate ### サポートされている要求パラメーター {#sam_soft_us_int-POST-createOrUpdate__entry__2}{#sam_soft_us_int-POST-createOrUpdate__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#sam_soft_us_int-POST-createOrUpdate__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#sam_soft_us_int-POST-createOrUpdate__entry__10} | 名前 | 説明 | |-|-| | items | ソフトウェア使用状況レコードに保存する各フィールドの列名と値のリスト。渡す必要がある列情報は、reclamation_type (必須フィールド) に指定する値によって異なります。可能な reclamation_type 値および渡す必要がある列情報： * total_usage： * configuration_item * last_used_time * month_used * norm_product * year {#sam_soft_us_int-POST-createOrUpdate__ul_cvy_2qh_zlb} * last_used_date： * configuration_item * norm_product {#sam_soft_us_int-POST-createOrUpdate__ul_pxb_jqh_zlb} {#sam_soft_us_int-POST-createOrUpdate__ul_rk3_zrc_zlb} これらのフィールドの組み合わせによってレコードが一意に識別されます。レコードがテーブルで見つからない場合は、指定されたフィールドを持つ新しいレコードが作成されます。それ以外の場合は、既存のレコードが更新されます。データタイプ：アレイ | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#sam_soft_us_int-POST-createOrUpdate__entry__14}{#sam_soft_us_int-POST-createOrUpdate__accept-RESTAPI}{#sam_soft_us_int-POST-createOrUpdate__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 4. 要求ヘッダー] {#sam_soft_us_int-POST-createOrUpdate__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#sam_soft_us_int-POST-createOrUpdate__entry__24}{#sam_soft_us_int-POST-createOrUpdate__entry-200-status-code}{#sam_soft_us_int-POST-createOrUpdate__entry-401-status-code}{#sam_soft_us_int-POST-createOrUpdate__entry-404-status-code}{#sam_soft_us_int-POST-createOrUpdate__entry-405-status-code}{#sam_soft_us_int-POST-createOrUpdate__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 404 | 見つかりません。要求アイテムが見つかりませんでした。 | | 405 | 無効なメソッドです。この機能は無効です。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#sam_soft_us_int-POST-createOrUpdate__entry__36} | 名前 | 説明 | |-|-| | items | ソフトウェア使用状況レコード内のすべてのフィールドの名前と値のペアのリスト。データタイプ：アレイ (内容はさまざまです) | [ ] ### cURL 要求次の例は、新しいソフトウェア使用状況レコードを作成する方法を示しています。 curl -X POST "https://instance.servicenow/api/now/sam_software_usage_integration/createOrUpdate" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{'items': [\ { 'configuration_item':'eaa9604d3790200044e0bfc8bcbe5dc1',\ 'month_used':2,\ 'norm_product':'40209c060b3022002d6c650d37673a89',\ 'norm_publisher':'24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type':'total_usage',\ 'usage_count': 13,\ 'total_usage_time':13,\ 'year':2020 }\ ]}"
{ "result": { "reply": { "items": [ { "configuration_item": "eaa9604d3790200044e0bfc8bcbe5dc1", "month_used": 2, "norm_product": "40209c060b3022002d6c650d37673a89", "norm_publisher": "24dcccc20b3022002d6c650d37673ab3", "reclamation_type": "total_usage", "usage_count": 13, "total_usage_time": 13, "year": 2020, "sysId": "13d15fe59d511010f8772c637e39afe5", "status": "INSERT" } ] }, "message": "Ok" } } 次の例は、複数のソフトウェア使用状況レコードを 1 回の呼び出しで更新する方法を示しています。 curl -X POST "https://instance.servicenow/api/now/sam_software_usage_integration/createOrUpdate" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{'items': [\ {\ 'configuration_item': 'eaa9604d3790200044e0bfc8bcbe5dc1',\ 'month_used': 2,\ 'norm_product': '40209c060b3022002d6c650d37673a89',\ 'norm_publisher': '24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type': 'total_usage',\ 'usage_count': 13,\ 'total_usage_time': 13,\ 'year': 2020 }, {\ 'configuration_item': '0aa9e80d3790200044e0bfc8bcbe5da0',\ 'month_used': 2,\ 'norm_product': '40209c060b3022002d6c650d37673a89',\ 'norm_publisher': '24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type': 'total_usage',\ 'usage_count': 19,\ 'total_usage_time': 19,\ 'year': 2020 }, {\ 'configuration_item': 'a0a9a80d3790200044e0bfc8bcbe5d3c',\ 'month_used': 2,\ 'norm_product': '40209c060b3022002d6c650d37673a89',\ 'norm_publisher': '24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type': 'total_usage',\ 'usage_count': 7,\ 'total_usage_time': 7,\ 'year': 2020}, {\ 'configuration_item': '48a9280d3790200044e0bfc8bcbe5d55',\ 'month_used': 2,\ 'norm_product': '40209c060b3022002d6c650d37673a89',\ 'norm_publisher': '24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type': 'total_usage',\ 'usage_count': 1,\ 'total_usage_time': 1,\ 'year': 2020}, {\ 'configuration_item': '61a9680d3790200044e0bfc8bcbe5d11',\ 'month_used': 2,\ 'norm_product': '40209c060b3022002d6c650d37673a89',\ 'norm_publisher': '24dcccc20b3022002d6c650d37673ab3',\ 'reclamation_type': 'total_usage',\ 'usage_count': 18,\ 'total_usage_time': 18,\ 'year': 2020} ]}"
{ "result": { "reply": { "items": [ { "configuration_item": "eaa9604d3790200044e0bfc8bcbe5dc1", "month_used": 2, "norm_product": "40209c060b3022002d6c650d37673a89", "norm_publisher": "24dcccc20b3022002d6c650d37673ab3", "reclamation_type": "total_usage", "usage_count": 13, "total_usage_time": 13, "year": 2020, "sysId": "13d15fe59d511010f8772c637e39afe5", "status": "INSERT" }, { "configuration_item": "0aa9e80d3790200044e0bfc8bcbe5da0", "month_used": 2, "norm_product": "40209c060b3022002d6c650d37673a89", "norm_publisher": "24dcccc20b3022002d6c650d37673ab3", "reclamation_type": "total_usage", "usage_count": 19, "total_usage_time": 19, "year": 2020, "sysId": "2cd15fe59d521010f9772c637e39aff4", "status": "UPDATE" }, { ... }, ] }, "message": "Ok" } }