コンシューマー API

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:27分
  • コンシューマー API は、カスタマーサービス管理 (CSM)コンシューマーレコードを取得して更新するためのエンドポイントを提供します。

    さらに、コンシューマーを作成するときに新しいソーシャルメディアプロファイルレコードを生成できます。

    コンシューマー API にはカスタマーサービスプラグイン (com.sn_customerservice) が必要で、これは now 名前空間内で提供されます。

    ユーザーには、完全な API アクセスのために csm_ws_integration ロールが必要です。

    コンシューマー:GET /now/consumer

    指定された カスタマーサービス管理 (CSM) コンシューマーレコードのセットを取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/consumer

    デフォルト URL: /api/now/consumer

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 1. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 2. クエリパラメーター
    名前 説明
    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

    エンコードされたクエリは 順番をサポートしています。特定のフィールドに基づいて応答をソートするには、sysparm_queryORDERBY 句と ORDERBYDESC 句を使用します。たとえば、 sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory は、すべてのアクティブなレコードをフィルタリングし、結果を最初に番号の昇順に並べ替え、次にカテゴリ別の降順に並べ替えます。

    無効なフィールド名を指定するなどしてクエリーの一部が無効な場合、インスタンスは無効な部分を無視します。次に、クエリの有効な部分のみを使用して行を返します。この動作は、プロパティ glide.invalid_query.returns_no_rows を使用して制御できます。無効なクエリで行を返さない場合は、このプロパティを true に設定します。
    注:
    glide.invalid_query.returns_no_rows プロパティは、リスト、スクリプト (GlideRecord.query())、Web サービス API など、インスタンス全体のすべてのクエリの動作を制御します。

    データタイプ:文字列

    表 : 3. 要求本文パラメーター (XML または JSON)
    要素 説明
    なし

    ヘッダー

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

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    受容 応答本文のデータ形式。サポートされているタイプ: application/json または application/xml

    デフォルト: application/json

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

    ステータスコード

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

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 見つかりません。要求されたアイテムが見つかりませんでした。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    エンドポイントは、応答本文で次の JSON または XML 要素を返す場合があります。以下で定義する要素のリスト (ベースシステムの要素を定義する) に加えて、エンドポイントはコンシューマー [csm_consumer] テーブルに追加されたカスタムフィールドも返します。これらの要素の詳細については、特定のテーブル定義 [システム定義 > テーブル].

    要素 説明
    アクティブ コンシューマーがアクティブかどうかを示すフラグ。

    可能な値:

    • true:コンシューマーアクティブ
    • false:コンシューマーが非アクティブ化されました

    データタイプ:ブール

    デフォルト:true

    会社_電話番号 コンシューマの勤務先電話番号。

    データタイプ:文字列

    最大長:40

    市区町村 コンシューマーが居住する市区町村。

    データタイプ:文字列

    最大長:100

    コンシューマーが居住する国。

    データタイプ:文字列

    最大長:40

    date_format 日付を表示する形式。

    有効な値:

    • dd-mm-yyyy
    • dd/mm/yyyy
    • dd.mm.yyyy
    • mm-dd-yyyy
    • yyyy-mm-dd

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システムの日付形式)

    メール コンシューマーのメールアドレス。

    データタイプ:文字列

    最大長:100

    ファックス コンシューマのファックス番号。

    データタイプ:文字列

    最大長:40

    first_name コンシューマーの名。

    データタイプ:文字列

    最大長:50

    性別 コンシューマーの性別。

    データタイプ:文字列

    最大長:40

    自宅_電話番号 コンシューマの自宅電話番号。

    データタイプ:文字列

    最大長:40

    世帯 世帯の特性を説明するレコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    last_name コンシューマーの姓。

    データタイプ:文字列

    最大長:50

    middle_name コンシューマーのミドルネーム。

    データタイプ:文字列

    最大長:50

    携帯_電話番号 コンシューマーの携帯電話番号。

    データタイプ:文字列

    最大長:40

    名前 コンシューマーの氏名。first_name+middle_name+last_name。

    データタイプ:文字列

    最大長:152

    メモ コンシューマーに関する注意事項。

    データタイプ:文字列

    最大長:4,000

    通知 コンシューマーが通知を受信するかどうかを示します。

    有効な値:

    • 1:無効
    • 2:有効

    データタイプ:数値 (整数)

    最大長:40

    デフォルト値:2

    番号 コンシューマーに関連付けられた一意の番号。

    データタイプ:文字列

    最大長:40

    写真 消費者の写真。

    データタイプ:画像

    preferred_language コンシューマーのプライマリ言語。

    データタイプ:文字列

    最大長:3

    プリフィックス コンシューマー名のプリフィックス (Dr.、Mr.、Mrs.、Ms など)

    データタイプ:文字列

    最大長:40

    プライマリ これがプライマリコンシューマーであるかどうかを示すフラグ。

    可能な値:

    • true:プライマリコンシューマー
    • false:プライマリコンシューマーではない

    データタイプ:ブール

    デフォルト値:false

    状況 コンシューマーが所在する都道府県。

    データタイプ:文字列

    最大長:100

    番地 コンシューマーの番地。

    データタイプ:文字列

    最大長: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 時間制)

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システム時間形式)

    time_zone カナダ/中部や米国/東部などのコンシューマーのタイムゾーン。

    データタイプ:文字列

    最大長:40

    title マネージャー、ソフトウェア開発者、請負業者などのコンシューマーの役職。

    データタイプ:文字列

    最大長:60

    user コンシューマーユーザーのSys_id。

    データタイプ:文字列

    テーブル:コンシューマーユーザー [csm_consumer_user]

    郵便番号 コンシューマーの郵便番号。

    データタイプ:文字列

    最大長: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}

    指定された カスタマーサービス管理 (CSM) コンシューマーレコードを取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/consumer/{id}

    デフォルト URL: /api/now/consumer/{id}

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 7. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    ID 返すコンシューマーレコードのSys_id。

    データタイプ:文字列

    テーブル:コンシューマー [csm_consumer]

    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

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

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    受容 応答本文のデータ形式。サポートされているタイプ: application/json または application/xml

    デフォルト: application/json

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

    ステータスコード

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

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    404 要求が無効であることを示します。次のいずれかの理由が考えられます。
    • 要求されたケースが存在しません。
    • ユーザーにコンシューマーレコードへのアクセス権がありません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    エンドポイントは、応答本文で次の JSON または XML 要素を返す場合があります。以下で定義する要素のリスト (ベースシステムの要素を定義する) に加えて、エンドポイントはコンシューマー [csm_consumer] テーブルに追加されたカスタムフィールドも返します。これらの要素の詳細については、特定のテーブル定義 [システム定義 > テーブル].

    要素 説明
    アクティブ コンシューマーがアクティブかどうかを示すフラグ。

    可能な値:

    • true:コンシューマーアクティブ
    • false:コンシューマーが非アクティブ化されました

    データタイプ:ブール

    デフォルト:true

    会社_電話番号 コンシューマの勤務先電話番号。

    データタイプ:文字列

    最大長:40

    市区町村 コンシューマーが居住する市区町村。

    データタイプ:文字列

    最大長:100

    コンシューマーが居住する国。

    データタイプ:文字列

    最大長:40

    date_format 日付を表示する形式。

    有効な値:

    • dd-mm-yyyy
    • dd/mm/yyyy
    • dd.mm.yyyy
    • mm-dd-yyyy
    • yyyy-mm-dd

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システムの日付形式)

    メール コンシューマーのメールアドレス。

    データタイプ:文字列

    最大長:100

    ファックス コンシューマのファックス番号。

    データタイプ:文字列

    最大長:40

    first_name コンシューマーの名。

    データタイプ:文字列

    最大長:50

    性別 コンシューマーの性別。

    データタイプ:文字列

    最大長:40

    自宅_電話番号 コンシューマの自宅電話番号。

    データタイプ:文字列

    最大長:40

    世帯 世帯の特性を説明するレコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    last_name コンシューマーの姓。

    データタイプ:文字列

    最大長:50

    middle_name コンシューマーのミドルネーム。

    データタイプ:文字列

    最大長:50

    携帯_電話番号 コンシューマーの携帯電話番号。

    データタイプ:文字列

    最大長:40

    名前 コンシューマーの氏名。first_name+middle_name+last_name。

    データタイプ:文字列

    最大長:152

    メモ コンシューマーに関する注意事項。

    データタイプ:文字列

    最大長:4,000

    通知 コンシューマーが通知を受信するかどうかを示します。

    有効な値:

    • 1:無効
    • 2:有効

    データタイプ:数値 (整数)

    最大長:40

    デフォルト値:2

    番号 コンシューマーに関連付けられた一意の番号。

    データタイプ:文字列

    最大長:40

    写真 消費者の写真。

    データタイプ:画像

    preferred_language コンシューマーのプライマリ言語。

    データタイプ:文字列

    最大長:3

    プリフィックス コンシューマー名のプリフィックス (Dr.、Mr.、Mrs.、Ms など)

    データタイプ:文字列

    最大長:40

    プライマリ これがプライマリコンシューマーであるかどうかを示すフラグ。

    可能な値:

    • true:プライマリコンシューマー
    • false:プライマリコンシューマーではない

    データタイプ:ブール

    デフォルト値:false

    状況 コンシューマーが所在する都道府県。

    データタイプ:文字列

    最大長:100

    番地 コンシューマーの番地。

    データタイプ:文字列

    最大長: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 時間制)

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システム時間形式)

    time_zone カナダ/中部や米国/東部などのコンシューマーのタイムゾーン。

    データタイプ:文字列

    最大長:40

    title マネージャー、ソフトウェア開発者、請負業者などのコンシューマーの役職。

    データタイプ:文字列

    最大長:60

    user コンシューマーユーザーのSys_id。

    データタイプ:文字列

    テーブル:コンシューマーユーザー [csm_consumer_user]

    郵便番号 コンシューマーの郵便番号。

    データタイプ:文字列

    最大長: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

    新しい カスタマーサービス管理 (CSM) コンシューマーを作成します。

    さらに、このエンドポイントを使用して、コンシューマーのソーシャルメディアプロファイルを作成できます。プロファイルを作成するには、要求本文で次のパラメーターを指定する必要があります。
    • social_channel
    • social_handle
    • social_handle_url
    警告:
    このエンドポイントでは、過剰なオーバーヘッドが発生する可能性があるため、パラメーターの検証は実行されません。要求パラメーターのスペルが間違っている、有効でない、またはエンドポイントでサポートされていない場合は、警告なしに無視されます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/consumer

    デフォルト URL: /api/now/consumer

    注:
    使用可能なバージョン は、REST API エクスプローラーで指定されます。スクリプト済み REST API の場合、[ スクリプト済み REST サービス] フォームに追加のバージョン情報があります。

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

    表 : 13. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ:文字列

    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    要素 説明
    アクティブ コンシューマーがアクティブかどうかを示すフラグ。

    可能な値:

    • true:コンシューマーアクティブ
    • false:コンシューマーが非アクティブ化されました

    データタイプ:ブール

    デフォルト:true

    会社_電話番号 コンシューマの勤務先電話番号。

    データタイプ:文字列

    最大長:40

    市区町村 コンシューマーが居住する市区町村。

    データタイプ:文字列

    最大長:100

    コンシューマーが居住する国。

    データタイプ:文字列

    最大長:40

    date_format 日付を表示する形式。

    有効な値:

    • dd-mm-yyyy
    • dd/mm/yyyy
    • dd.mm.yyyy
    • mm-dd-yyyy
    • yyyy-mm-dd

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システムの日付形式)

    メール コンシューマーのメールアドレス。

    データタイプ:文字列

    最大長:100

    ファックス コンシューマのファックス番号。

    データタイプ:文字列

    最大長:40

    first_name コンシューマーの名。

    データタイプ:文字列

    最大長:50

    性別 コンシューマーの性別。

    データタイプ:文字列

    最大長:40

    自宅_電話番号 コンシューマの自宅電話番号。

    データタイプ:文字列

    最大長:40

    世帯 世帯の特性を説明するレコードのSys_id。

    データタイプ:文字列

    テーブル:世帯 [csm_household]

    last_name コンシューマーの姓。

    データタイプ:文字列

    最大長:50

    middle_name コンシューマーのミドルネーム。

    データタイプ:文字列

    最大長:50

    携帯_電話番号 コンシューマーの携帯電話番号。

    データタイプ:文字列

    最大長:40

    名前 コンシューマーの氏名。first_name+middle_name+last_name。

    データタイプ:文字列

    最大長:152

    メモ コンシューマーに関する注意事項。

    データタイプ:文字列

    最大長:4,000

    通知 コンシューマーが通知を受信するかどうかを示します。

    有効な値:

    • 1:無効
    • 2:有効

    データタイプ:数値 (整数)

    最大長:40

    デフォルト値:2

    写真 消費者の写真。

    データタイプ:画像

    preferred_language コンシューマーのプライマリ言語。

    データタイプ:文字列

    最大長:3

    プリフィックス コンシューマー名のプリフィックス (Dr.、Mr.、Mrs.、Ms など)

    データタイプ:文字列

    最大長:40

    プライマリ これがプライマリコンシューマーであるかどうかを示すフラグ。

    可能な値:

    • true:プライマリコンシューマー
    • false:プライマリコンシューマーではない

    データタイプ:ブール

    デフォルト値:false

    social_channel Twitter、Facebook、Instagram など、コンシューマーが関連付けられているソーシャルメディアチャネル。

    データタイプ:文字列

    social_handle ソーシャルメディアチャネルのユーザーハンドル。

    データタイプ:文字列

    social_handle_url コンシューマーのソーシャルチャネルハンドルへの URL。

    データタイプ:文字列

    状況 コンシューマーが所在する都道府県。

    データタイプ:文字列

    最大長:100

    番地 コンシューマーの番地。

    データタイプ:文字列

    最大長: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 時間制)

    データタイプ:文字列

    最大長:40

    デフォルト:空 (システム時間形式)

    time_zone カナダ/中部や米国/東部などのコンシューマーのタイムゾーン。

    データタイプ:文字列

    最大長:40

    title マネージャー、ソフトウェア開発者、請負業者などのコンシューマーの役職。

    データタイプ:文字列

    最大長:60

    user コンシューマーユーザーのSys_id。

    データタイプ:文字列

    テーブル:コンシューマーユーザー [csm_consumer_user]

    郵便番号 コンシューマーの郵便番号。

    データタイプ:文字列

    最大長:40

    ヘッダー

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

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    受容 応答本文のデータ形式。application/jsonのみをサポートしています。
    Content-Type 要求本文のデータ形式。application/jsonのみをサポートしています。
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

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

    表 : 18. ステータスコード
    ステータスコード 説明
    201 新しいコンシューマーレコードが正常に作成されました。
    400 要求が正しくありません。不正な要求タイプまたは不正な形式の要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー。サーバー側のコードでロジックエラーが発生しました。

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

    要素 説明
    結果 新しく作成されたコンシューマーレコードの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"
    }