--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # コンシューマー API # コンシューマー API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：27分コンシューマー API は、カスタマーサービス管理 (CSM)コンシューマーレコードを取得および更新するためのエンドポイントを提供します。さらに、コンシューマーの作成時に新しいソーシャルメディアプロファイルレコードを生成できます。コンシューマー API にはカスタマーサービスプラグイン (com.sn_customerservice) が必要であり、`now` 名前空間内で提供されます。ユーザーが API にフルアクセスするためには、csm_ws_integration ロールが必要です。 ## コンシューマー - GET /now/consumer {#ariaid-title2} 指定されたカスタマーサービス管理 (CSM) コンシューマーレコードのセットを取得します。 ### URL 形式バージョニングされた URL：/api/now/{api_version}/consumer デフォルトの URL：/api/now/consumer ### サポートされている要求パラメーター {#consumer-GET__entry__2}{#consumer-GET__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#consumer-GET__entry__6}{#consumer-GET__sysparm-limit-entry}{#consumer-GET__sysparm-offset-entry}{#consumer-GET__sysparm-query-entry} | 名前 | 説明 | |-|-| | sysparm_limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、sysparm_offset パラメーターを使用してレコード取得をページネーションします。応答では、ブール値のパラメーター hasMore が返されます。フィルター基準を満たす、返されるレコードがまだあるかどうかを示します。データタイプ：数値デフォルト：10 | | sysparm_offset | レコード取得を開始するレコードのインデックス。この値を使用して、レコード取得をページネーションします。この機能により、レコード数に関係なく、管理しやすい小さなチャンクに分割してすべてのレコードを取得できます。たとえば、このエンドポイントを初めて呼び出すときに、sysparm_offset は「0」に設定されます。単に利用可能なすべてのレコードをページングするには、すべてのレコードの終わりに達するまで「`sysparm_offset=sysparm_offset+sysparm_limit`」を使用します。 sysparm_offset パラメーターには負数を指定しないでください。データタイプ：数値デフォルト：0 | | sysparm_query | 結果セットのフィルタリングに使用されるエンコードされたクエリ。例： `sysparm_query=caller_id=javascript:gs.getUserID()^active=true` エンコードされたクエリは、順序をサポートしています。特定のフィールドに基づいて回答を並べ替えるには、ORDERBY と ORDERBYDESC の句を sysparm_query で使用します。たとえば、`sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory` はすべてのアクティブなレコードをフィルタリングし、最初に番号によって昇順に、次にカテゴリによって降順に結果を並び替えます。フィールド名が無効というようにクエリの一部が無効であると、インスタンスは無効な部分を無視します。次に、クエリの有効部分のみを使用して行を返します。この動作は glide.invalid_query.returns_no_rows プロパティを使用してコントロールできます。無効なクエリに行を返さないようにするには、このプロパティを true に設定します。注: glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンスのすべてのクエリの動作を管理します。データタイプ：文字列 | [表 : 2. クエリパラメーター] {#consumer-GET__entry__14} | 要素 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-GET__entry__18}{#consumer-GET__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 4. 要求ヘッダー] {#consumer-GET__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-GET__entry__26}{#consumer-GET__entry-200-status-code}{#consumer-GET__entry-401-status-code}{#consumer-GET__entry-404-status-code}{#consumer-GET__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 404 | 見つかりません。要求アイテムが見つかりませんでした。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) エンドポイントでは、次の JSON または XML 要素を応答本文で返すことができます。以下で定義する (ベースシステムにある要素を定義する) 要素のリストに加えて、エンドポイントでは、コンシューマー \[csm_consumer\] テーブルに追加されたカスタムフィールドも返します。これらの要素の詳細については、特定のテーブル定義 \[システム定義テーブル\]. {#consumer-GET__csmconsumer_response_parms__entry__2}{#consumer-GET__consumertable-active-entry}{#consumer-GET__consumertable-business_phone-entry}{#consumer-GET__consumertable-city-entry}{#consumer-GET__consumertable-country-entry}{#consumer-GET__consumertable-date_format-entry}{#consumer-GET__consumertable-email-entry}{#consumer-GET__consumertable-fax-entry}{#consumer-GET__consumertable-first_name-entry}{#consumer-GET__consumertable-gender-entry}{#consumer-GET__consumertable-home_phone-entry}{#consumer-GET__consumertable-household-entry}{#consumer-GET__consumertable-last_name-entry}{#consumer-GET__consumertable-middle_name-entry}{#consumer-GET__consumertable-mobile_phone-entry}{#consumer-GET__consumertable-name-entry}{#consumer-GET__consumertable-notes-entry}{#consumer-GET__consumertable-notification-entry}{#consumer-GET__consumertable-number-entry}{#consumer-GET__consumertable-photo-entry}{#consumer-GET__consumertable-preferred_language-entry}{#consumer-GET__consumertable-prefix-entry}{#consumer-GET__consumertable-primary-entry}{#consumer-GET__consumertable-state-entry}{#consumer-GET__consumertable-street-entry}{#consumer-GET__consumertable-suffix-entry}{#consumer-GET__consumertable-sys_created_by-entry}{#consumer-GET__consumertable-sys_created_on-entry}{#consumer-GET__consumertable-sys_domain-entry}{#consumer-GET__consumertable-sys_id-entry}{#consumer-GET__consumertable-sys_mod_count-entry}{#consumer-GET__consumertable-sys_updated_by-entry}{#consumer-GET__consumertable-sys_updated_on-entry}{#consumer-GET__consumertable-time_format-entry}{#consumer-GET__consumertable-time_zone-entry}{#consumer-GET__consumertable-title-entry}{#consumer-GET__consumertable-user-entry}{#consumer-GET__consumertable-zip-entry} | 要素 | 説明 | |-|-| | active | コンシューマーがアクティブかどうかを示すフラグ。可能な値： * true：コンシューマーがアクティブ * false：コンシューマーが非アクティブ {#consumer-GET__ul_asy_4b3_2hb} データタイプ：ブールデフォルト：true | | business_phone | コンシューマーの勤務先電話番号。データタイプ：文字列最大長：40 | | city | コンシューマーが居住する市区町村。データタイプ：文字列最大長：100 | | country | コンシューマーが居住する国。データタイプ：文字列最大長：40 | | date_format | 日付を表示する形式。有効な値： * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-GET__ul_jsj_qwc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式) | | email | コンシューマーのメールアドレス。データタイプ：文字列最大長：100 | | fax | コンシューマーのファックス番号。データタイプ：文字列最大長：40 | | first_name | コンシューマーの名。データタイプ：文字列最大長：50 | | gender | コンシューマーの性別。データタイプ：文字列最大長：40 | | home_phone | コンシューマーの自宅電話番号。データタイプ：文字列最大長：40 | | 世帯 | 世帯の特性を説明するレコードの sys_id。世帯 \[csm_household\] テーブルにあります。データタイプ：文字列 | | last_name | コンシューマーの姓。データタイプ：文字列最大長：50 | | middle_name | コンシューマーのミドルネーム。データタイプ：文字列最大長：50 | | mobile_phone | コンシューマーの携帯電話番号。データタイプ：文字列最大長：40 | | name | コンシューマーのフルネーム。 first_name+middle_name+last_name。データタイプ：文字列最大長：152 | | notes | コンシューマーに関するメモ。データタイプ：文字列最大長：4,000 | | 通知 | コンシューマーが通知を受信するかどうかを示します。有効な値： * 1：無効 * 2：有効 {#consumer-GET__ul_o5d_pyh_2hb} データタイプ：整数最大長：40 デフォルト値：2 | | number | コンシューマーに関連付けられた一意の番号。データタイプ：文字列最大長：40 | | photo | コンシューマーの写真。データタイプ：画像 | | preferred_language | コンシューマーのプライマリ言語。データタイプ：文字列最大長：3 | | prefix | Dr.、Mr.、Mrs.、Ms. などのコンシューマー名のプリフィックスデータタイプ：文字列最大長：40 | | primary | これがプライマリコンシューマーであるかどうかを示すフラグ。可能な値： * true：プライマリコンシューマー * false：プライマリコンシューマーではない {#consumer-GET__ul_yns_yb3_2hb} データタイプ：ブールデフォルト値：false | | state | コンシューマーが居住する都道府県。データタイプ：文字列最大長：100 | | street | コンシューマーの番地。データタイプ：文字列最大長：255 | | サフィックス | Jr.、Sr.、II などのコンシューマー名のサフィックス。データタイプ：文字列 | | sys_created_by | コンシューマーレコードを作成したユーザー。データタイプ：文字列最大長：40 | | sys_created_on | コンシューマーレコードが最初に作成された日時。データタイプ：文字列 | | sys_domain | コンシューマー情報が存在する ServiceNow ドメイン。データタイプ：文字列 | | sys_id | コンシューマーの一意の識別子。データタイプ：文字列 | | sys_mod_count | 関連するコンシューマー情報が変更された回数。データタイプ：整数 | | sys_tags | システムタグ。データタイプ：文字列 | | sys_updated_by | コンシューマー情報を最後に更新したユーザー。データタイプ：文字列最大長：40 | | sys_updated_on | コンシューマー情報が最後に更新された日時。データタイプ：文字列 | | time_format | 時間を表示する形式。有効な値： * hh.mm.ss a: hh.mm.ss (12 時間制) * hh:mm:ss a: hh:mm:ss (12 時間制) * HH.mm.ss: hh.mm.ss (24 時間制) * HH:mm:ss: hh:mm:ss (24 時間制) {#consumer-GET__ul_kvg_gxc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式) | | time_zone | コンシューマーのタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40 | | title | マネージャー、ソフトウェア開発者、請負業者などのコンシューマーのビジネスタイトル。データタイプ：文字列最大長：60 | | user | コンシューマーユーザーの sys_id。コンシューマーユーザー \[csm_consumer\] テーブルにあります。データタイプ：文字列 | | zip | コンシューマーの郵便番号。データタイプ：文字列最大長：40 | [ ] ### cURL 要求 curl "https://instance.servicenow.com/api/now/consumer?sysparm_query=account=86837a386f0331003b3c498f5d3ee4ca&sysparm_limit=2&sysparm_offset=2>;rel="next" \ --request GET \ --header "Accept:application/json" \ --user "username":"password" { "result": [ { "country": "USA", "notes": "", "gender": "Male", "city": "Plano", "prefix": "", "sys_updated_on": "2016-08-12 00:19:12", "suffix": "", "title": "", "number": "CSMR0000004", "notification": "2", "sys_id": "01d8403fdb1b1200b6075200cf961941", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "6900 Dallas Pkwy", "sys_created_on": "2016-06-16 19:20:13", "sys_domain": "global", "state": "TX", "fax": "", "first_name": "Harding", "email": "harding.asher@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "75024", "home_phone": "", "time_format": "", "sys_mod_count": "8", "last_name": "Asher", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Harding Asher", "household": "", "date_format": "", "user": "c3d35d82c37122005871d44d81d3ae91", "primary": "false" }, { "country": "USA", "notes": "", "gender": "Male", "city": "San Francisco", "prefix": "", "sys_updated_on": "2016-08-12 00:20:27", "suffix": "", "title": "", "number": "CSMR0000002", "notification": "2", "sys_id": "a0488cfbdb1b1200b6075200cf9619db", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "144 2nd St", "sys_created_on": "2016-06-16 19:17:44", "sys_domain": "global", "state": "CA", "fax": "", "first_name": "Sam", "email": "sam.collins@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "94105", "home_phone": "", "time_format": "", "sys_mod_count": "13", "last_name": "Collins", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Sam Collins", "household": "", "date_format": "", "user": "64488cfbdb1b1200b6075200cf9619db", "primary": "false" } ] } ## コンシューマー - GET /now/consumer/{id} {#ariaid-title3} 指定されたカスタマーサービス管理 (CSM) コンシューマーレコードを取得します。 ### URL 形式バージョニングされた URL：/api/now/{api_version}/consumer/{id} デフォルトの URL：/api/now/consumer/{id} ### サポートされている要求パラメーター {#consumer-GET-id__entry__2}{#consumer-GET-id__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | id | 返されるコンシューマーレコードの sys_id。コンシューマー \[csm_consumer\] テーブルにあります。データタイプ：文字列 | [表 : 7. パスパラメーター] {#consumer-GET-id__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 8. クエリパラメーター] {#consumer-GET-id__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-GET-id__entry__16}{#consumer-GET-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 10. 要求ヘッダー] {#consumer-GET-id__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-GET-id__entry__24}{#consumer-GET-id__entry-200-status-code}{#consumer-GET-id__entry-401-status-code}{#consumer-GET-id__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 404 | 要求が無効であることを示します。次のいずれかの理由が考えられます。 * 要求されたケースが存在しません。 * ユーザーにコンシューマーレコードへのアクセス権がありません。 {#consumer-GET-id__ul_ubm_1jl_3v} | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター (JSON または XML) エンドポイントでは、次の JSON または XML 要素を応答本文で返すことができます。以下で定義する (ベースシステムにある要素を定義する) 要素のリストに加えて、エンドポイントでは、コンシューマー \[csm_consumer\] テーブルに追加されたカスタムフィールドも返します。これらの要素の詳細については、特定のテーブル定義 \[システム定義テーブル\]. {#consumer-GET-id__csmconsumer_response_parms__entry__2}{#consumer-GET-id__consumertable-active-entry}{#consumer-GET-id__consumertable-business_phone-entry}{#consumer-GET-id__consumertable-city-entry}{#consumer-GET-id__consumertable-country-entry}{#consumer-GET-id__consumertable-date_format-entry}{#consumer-GET-id__consumertable-email-entry}{#consumer-GET-id__consumertable-fax-entry}{#consumer-GET-id__consumertable-first_name-entry}{#consumer-GET-id__consumertable-gender-entry}{#consumer-GET-id__consumertable-home_phone-entry}{#consumer-GET-id__consumertable-household-entry}{#consumer-GET-id__consumertable-last_name-entry}{#consumer-GET-id__consumertable-middle_name-entry}{#consumer-GET-id__consumertable-mobile_phone-entry}{#consumer-GET-id__consumertable-name-entry}{#consumer-GET-id__consumertable-notes-entry}{#consumer-GET-id__consumertable-notification-entry}{#consumer-GET-id__consumertable-number-entry}{#consumer-GET-id__consumertable-photo-entry}{#consumer-GET-id__consumertable-preferred_language-entry}{#consumer-GET-id__consumertable-prefix-entry}{#consumer-GET-id__consumertable-primary-entry}{#consumer-GET-id__consumertable-state-entry}{#consumer-GET-id__consumertable-street-entry}{#consumer-GET-id__consumertable-suffix-entry}{#consumer-GET-id__consumertable-sys_created_by-entry}{#consumer-GET-id__consumertable-sys_created_on-entry}{#consumer-GET-id__consumertable-sys_domain-entry}{#consumer-GET-id__consumertable-sys_id-entry}{#consumer-GET-id__consumertable-sys_mod_count-entry}{#consumer-GET-id__consumertable-sys_updated_by-entry}{#consumer-GET-id__consumertable-sys_updated_on-entry}{#consumer-GET-id__consumertable-time_format-entry}{#consumer-GET-id__consumertable-time_zone-entry}{#consumer-GET-id__consumertable-title-entry}{#consumer-GET-id__consumertable-user-entry}{#consumer-GET-id__consumertable-zip-entry} | 要素 | 説明 | |-|-| | active | コンシューマーがアクティブかどうかを示すフラグ。可能な値： * true：コンシューマーがアクティブ * false：コンシューマーが非アクティブ {#consumer-GET-id__ul_asy_4b3_2hb} データタイプ：ブールデフォルト：true | | business_phone | コンシューマーの勤務先電話番号。データタイプ：文字列最大長：40 | | city | コンシューマーが居住する市区町村。データタイプ：文字列最大長：100 | | country | コンシューマーが居住する国。データタイプ：文字列最大長：40 | | date_format | 日付を表示する形式。有効な値： * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-GET-id__ul_jsj_qwc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式) | | email | コンシューマーのメールアドレス。データタイプ：文字列最大長：100 | | fax | コンシューマーのファックス番号。データタイプ：文字列最大長：40 | | first_name | コンシューマーの名。データタイプ：文字列最大長：50 | | gender | コンシューマーの性別。データタイプ：文字列最大長：40 | | home_phone | コンシューマーの自宅電話番号。データタイプ：文字列最大長：40 | | 世帯 | 世帯の特性を説明するレコードの sys_id。世帯 \[csm_household\] テーブルにあります。データタイプ：文字列 | | last_name | コンシューマーの姓。データタイプ：文字列最大長：50 | | middle_name | コンシューマーのミドルネーム。データタイプ：文字列最大長：50 | | mobile_phone | コンシューマーの携帯電話番号。データタイプ：文字列最大長：40 | | name | コンシューマーのフルネーム。 first_name+middle_name+last_name。データタイプ：文字列最大長：152 | | notes | コンシューマーに関するメモ。データタイプ：文字列最大長：4,000 | | 通知 | コンシューマーが通知を受信するかどうかを示します。有効な値： * 1：無効 * 2：有効 {#consumer-GET-id__ul_o5d_pyh_2hb} データタイプ：整数最大長：40 デフォルト値：2 | | number | コンシューマーに関連付けられた一意の番号。データタイプ：文字列最大長：40 | | photo | コンシューマーの写真。データタイプ：画像 | | preferred_language | コンシューマーのプライマリ言語。データタイプ：文字列最大長：3 | | prefix | Dr.、Mr.、Mrs.、Ms. などのコンシューマー名のプリフィックスデータタイプ：文字列最大長：40 | | primary | これがプライマリコンシューマーであるかどうかを示すフラグ。可能な値： * true：プライマリコンシューマー * false：プライマリコンシューマーではない {#consumer-GET-id__ul_yns_yb3_2hb} データタイプ：ブールデフォルト値：false | | state | コンシューマーが居住する都道府県。データタイプ：文字列最大長：100 | | street | コンシューマーの番地。データタイプ：文字列最大長：255 | | サフィックス | Jr.、Sr.、II などのコンシューマー名のサフィックス。データタイプ：文字列 | | sys_created_by | コンシューマーレコードを作成したユーザー。データタイプ：文字列最大長：40 | | sys_created_on | コンシューマーレコードが最初に作成された日時。データタイプ：文字列 | | sys_domain | コンシューマー情報が存在する ServiceNow ドメイン。データタイプ：文字列 | | sys_id | コンシューマーの一意の識別子。データタイプ：文字列 | | sys_mod_count | 関連するコンシューマー情報が変更された回数。データタイプ：整数 | | sys_updated_by | コンシューマー情報を最後に更新したユーザー。データタイプ：文字列最大長：40 | | sys_updated_on | コンシューマー情報が最後に更新された日時。データタイプ：文字列 | | time_format | 時間を表示する形式。有効な値： * hh.mm.ss a: hh.mm.ss (12 時間制) * hh:mm:ss a: hh:mm:ss (12 時間制) * HH.mm.ss: hh.mm.ss (24 時間制) * HH:mm:ss: hh:mm:ss (24 時間制) {#consumer-GET-id__ul_kvg_gxc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式) | | time_zone | コンシューマーのタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40 | | title | マネージャー、ソフトウェア開発者、請負業者などのコンシューマーのビジネスタイトル。データタイプ：文字列最大長：60 | | user | コンシューマーユーザーの sys_id。コンシューマーユーザー \[csm_consumer\] テーブルにあります。データタイプ：文字列 | | zip | コンシューマーの郵便番号。データタイプ：文字列最大長：40 | [ ] ### cURL 要求 curl "https://instance.servicenow.com/api/now/consumer/01d8403fdb1b1200b6075200cf961941 \ --request GET \ --header "Accept:application/json" \ --user "username":"password" { "result": { "country": "USA", "notes": "", "gender": "Male", "city": "Plano", "prefix": "", "sys_updated_on": "2016-08-12 00:19:12", "suffix": "", "title": "", "number": "CSMR0000004", "notification": "2", "sys_id": "01d8403fdb1b1200b6075200cf961941", "business_phone": "", "sys_updated_by": "prithvi", "mobile_phone": "", "street": "6900 Dallas Pkwy", "sys_created_on": "2016-06-16 19:20:13", "sys_domain": "global", "state": "TX", "fax": "", "first_name": "Harding", "email": "harding.asher@mailinator.com", "preferred_language": "", "sys_created_by": "guest", "zip": "75024", "home_phone": "", "time_format": "", "sys_mod_count": "8", "last_name": "Asher", "photo": "", "active": "true", "middle_name": "", "time_zone": "", "sys_tags": "", "name": "Harding Asher", "household": "", "date_format": "", "user": "c3d35d82c37122005871d44d81d3ae91", "primary": "false" } } ## コンシューマー - POST /now/consumer {#ariaid-title4} 新しいカスタマーサービス管理 (CSM) コンシューマーを作成します。さらに、このエンドポイントを使用して、コンシューマーのソーシャルメディアプロファイルを作成できます。プロファイルを作成するには、要求本文で次のパラメーターを指定する必要があります。 * social_channel * social_handle * social_handle_url {#consumer-POST__ul_ntx_lg4_pgb} 警告: このエンドポイントでパラメーターの検証を実行すると、過度のオーバーヘッドが発生する可能性があるため、パラメーターの検証を実行しません。要求パラメーターが、スペルが間違っている、有効ではない、またはエンドポイントでサポートされていない場合、警告なしで無視されます。 ### URL 形式バージョニングされた URL：/api/now/{api_version}/consumer デフォルトの URL：/api/now/consumer ### サポートされている要求パラメーター {#consumer-POST__entry__2}{#consumer-POST__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 13. パスパラメーター] {#consumer-POST__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#consumer-POST__entry__10}{#consumer-POST__consumertable-active-entry}{#consumer-POST__consumertable-business_phone-entry}{#consumer-POST__consumertable-city-entry}{#consumer-POST__consumertable-country-entry}{#consumer-POST__consumertable-date_format-entry}{#consumer-POST__consumertable-email-entry}{#consumer-POST__consumertable-fax-entry}{#consumer-POST__consumertable-first_name-entry}{#consumer-POST__consumertable-gender-entry}{#consumer-POST__consumertable-home_phone-entry}{#consumer-POST__consumertable-household-entry}{#consumer-POST__consumertable-last_name-entry}{#consumer-POST__consumertable-middle_name-entry}{#consumer-POST__consumertable-mobile_phone-entry}{#consumer-POST__consumertable-name-entry}{#consumer-POST__consumertable-notes-entry}{#consumer-POST__consumertable-notification-entry}{#consumer-POST__consumertable-photo-entry}{#consumer-POST__consumertable-preferred_language-entry}{#consumer-POST__consumertable-prefix-entry}{#consumer-POST__consumertable-primary-entry}{#consumer-POST__consumertable-state-entry}{#consumer-POST__consumertable-street-entry}{#consumer-POST__consumertable-suffix-entry}{#consumer-POST__consumertable-time_format-entry}{#consumer-POST__consumertable-time_zone-entry}{#consumer-POST__consumertable-title-entry}{#consumer-POST__consumertable-user-entry}{#consumer-POST__consumertable-zip-entry} | 要素 | 説明 | |-|-| | active | コンシューマーがアクティブかどうかを示すフラグ。可能な値： * true：コンシューマーがアクティブ * false：コンシューマーが非アクティブ {#consumer-POST__ul_asy_4b3_2hb} データタイプ：ブールデフォルト：true | | business_phone | コンシューマーの勤務先電話番号。データタイプ：文字列最大長：40 | | city | コンシューマーが居住する市区町村。データタイプ：文字列最大長：100 | | country | コンシューマーが居住する国。データタイプ：文字列最大長：40 | | date_format | 日付を表示する形式。有効な値： * dd-mm-yyyy * dd/mm/yyyy * dd.mm.yyyy * mm-dd-yyyy * yyyy-mm-dd {#consumer-POST__ul_jsj_qwc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム日付形式) | | email | コンシューマーのメールアドレス。データタイプ：文字列最大長：100 | | fax | コンシューマーのファックス番号。データタイプ：文字列最大長：40 | | first_name | コンシューマーの名。データタイプ：文字列最大長：50 | | gender | コンシューマーの性別。データタイプ：文字列最大長：40 | | home_phone | コンシューマーの自宅電話番号。データタイプ：文字列最大長：40 | | 世帯 | 世帯の特性を説明するレコードの sys_id。世帯 \[csm_household\] テーブルにあります。データタイプ：文字列 | | last_name | コンシューマーの姓。データタイプ：文字列最大長：50 | | middle_name | コンシューマーのミドルネーム。データタイプ：文字列最大長：50 | | mobile_phone | コンシューマーの携帯電話番号。データタイプ：文字列最大長：40 | | name | コンシューマーのフルネーム。 first_name+middle_name+last_name。データタイプ：文字列最大長：152 | | notes | コンシューマーに関するメモ。データタイプ：文字列最大長：4,000 | | 通知 | コンシューマーが通知を受信するかどうかを示します。有効な値： * 1：無効 * 2：有効 {#consumer-POST__ul_o5d_pyh_2hb} データタイプ：整数最大長：40 デフォルト値：2 | | photo | コンシューマーの写真。データタイプ：画像 | | preferred_language | コンシューマーのプライマリ言語。データタイプ：文字列最大長：3 | | prefix | Dr.、Mr.、Mrs.、Ms. などのコンシューマー名のプリフィックスデータタイプ：文字列最大長：40 | | primary | これがプライマリコンシューマーであるかどうかを示すフラグ。可能な値： * true：プライマリコンシューマー * false：プライマリコンシューマーではない {#consumer-POST__ul_yns_yb3_2hb} データタイプ：ブールデフォルト値：false | | social_channel | コンシューマーが関連付けられているソーシャルメディアチャネル (Twitter、Facebook、Instagram など)。データタイプ：文字列 | | social_handle | ソーシャルメディアチャネルのユーザーハンドル。データタイプ：文字列 | | social_handle_url | コンシューマーのソーシャルチャネルハンドルへの URL。データタイプ：文字列 | | state | コンシューマーが居住する都道府県。データタイプ：文字列最大長：100 | | street | コンシューマーの番地。データタイプ：文字列最大長：255 | | サフィックス | Jr.、Sr.、II などのコンシューマー名のサフィックス。データタイプ：文字列 | | time_format | 時間を表示する形式。有効な値： * hh.mm.ss a: hh.mm.ss (12 時間制) * hh:mm:ss a: hh:mm:ss (12 時間制) * HH.mm.ss: hh.mm.ss (24 時間制) * HH:mm:ss: hh:mm:ss (24 時間制) {#consumer-POST__ul_kvg_gxc_2hb} データタイプ：文字列最大長：40 デフォルト：空 (システム時間形式) | | time_zone | コンシューマーのタイムゾーン (カナダ/中央または米国/東部)。データタイプ：文字列最大長：40 | | title | マネージャー、ソフトウェア開発者、請負業者などのコンシューマーのビジネスタイトル。データタイプ：文字列最大長：60 | | user | コンシューマーユーザーの sys_id。コンシューマーユーザー \[csm_consumer\] テーブルにあります。データタイプ：文字列 | | zip | コンシューマーの郵便番号。データタイプ：文字列最大長：40 | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-POST__entry__76}{#consumer-POST__accept-JSON-only-entry-RESTAPI}{#consumer-POST__content_type-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 | [表 : 16. 要求ヘッダー] {#consumer-POST__entry__82} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#consumer-POST__entry__86}{#consumer-POST__entry-401-status-code} | ステータスコード | 説明 | |-|-| | 201 | 新しいコンシューマーレコードが正常に作成されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 500 | 内部サーバーエラー。サーバー側のコードで論理エラーが発生しました。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#consumer-POST__entry__96} | 要素 | 説明 | |-|-| | result | 新しく作成されたコンシューマーレコードの sys_id。データタイプ：文字列 | [ ] ### cURL 要求 curl -X POST "https://instance.servicenow.com/api/now/consumer" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d " { \ "country": "USA", \ "notes": "Never comes in before 10am", \ "gender": "Female", \ "city": "San Marcos", \ "prefix": "Ms", \ "title": "Director", \ "notification": "1", \ "business_phone": "(555)555-1234", \ "mobile_phone": "(555)555-1235", \ "street": "123 Sesame St", \ "state": "CA", \ "fax": "(555)555-1236", \ "first_name": "Jane", \ "zip": "92001", \ "home_phone": "(555)555-1234", \ "last_name": "Brown", \ "active": "true", \ "middle_name": "Dell", \ "time_zone": "PST", \ "name": "Jane Brown", \ "household": "4", \ "user": "c3d35d82c37122005871d44d81d3ae91", \ "primary": "false" \ }" --user "username":"password" { "result": "0f5c13addb93230057c3fd441d9619b8" }