アカウント API

Yokohama API リファレンス

Release

yokohama

ft:locale

ja-JP

ft:publication_title

Yokohama API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

アカウント API

リリースバージョン: Yokohama

更新日 2025年01月30日

所要時間：25分

アカウント API は、カスタマーサービス管理 (CSM) アカウントレコードを取得するためのエンドポイントを提供します。

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

ユーザーが API にフルアクセスするためには、csm_ws_integration ロールが必要です。

アカウント - GET /now/account

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

URL 形式

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

デフォルトの URL：/api/now/account

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

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

表 : 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` エンコードされたクエリは、順序をサポートしています。特定のフィールドに基づいて回答を並べ替えるには、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 など、インスタンスのすべてのクエリの動作を管理します。データタイプ：文字列

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

ヘッダー

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

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

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

ステータスコード

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

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

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


パラメーター	説明
account_code	アプリケーションが予算予測と予算計画を識別するために使用する値の一意の組み合わせ。データタイプ：文字列最大長：255
account_parent	このアカウントの親アカウントの sys_id。アカウント [customer_account] テーブルにあります。データタイプ：文字列
account_path	アカウント階層内の親アカウントから子アカウントへのパス。データタイプ：文字列最大長：255
active_escalation	アカウントに関連付けられたアクティブなエスカレーションの sys_id。データタイプ：文字列テーブル:エスカレーション [sn_customerservice_escalation]
apple_icon	iPhone ホームページのブックマークのアイコン。データタイプ：画像
banner_image	カスタマーポータルに表示されるバナー画像。データタイプ：画像
banner_image_light	小さなバナー画像。データタイプ：画像
banner_text	カスタマーポータルに表示されるバナーテキスト。データタイプ：文字列最大長：4,000
city	このアカウントに関連付けられている会社が所在する市。データタイプ：文字列最大長：50
contact	このアカウントに関連付けられた連絡先レコードの sys_id。データタイプ：文字列テーブル:ユーザー [sys_user]
国	このアカウントに関連付けられている会社が所在する国。データタイプ：文字列最大長：40 デフォルト： USA
customer	アカウントがパートナーアカウントではなく、顧客アカウントであるかどうかを示すフラグ。可能な値： true：顧客アカウント false：パートナーアカウントデータタイプ：ブールデフォルト値：false
discount	購入時にアカウントに付与される割引。データタイプ：数値最大長：15
fax_phone	このアカウントに関連付けられている会社の主要な FAX 電話番号。データタイプ：文字列最大長：40
fiscal_year	アカウントに関連付けられている会社の会計年度。データタイプ：文字列
lat_long_error	緯度および経度情報と比較した実際の場所の差。データタイプ：文字列最大長：1,000
緯度	このアカウントに関連付けられている会社の緯度。データタイプ：数値 (浮動小数点) 最大長：40
経度	このアカウントに関連付けられている会社の経度。データタイプ：数値 (浮動小数点) 最大長：40
manufacturer	このアカウントに関連付けられている会社が商品を製造しているかどうかを示すフラグ。可能な値： true：商品を製造している false：商品を製造していないデータタイプ：ブールデフォルト値：false
market_cap	関連付けられている会社の公開株式の時価。データタイプ：数値 (通貨) 最大長：20
name	このアカウントに関連付けられている会社の名前。データタイプ：文字列最大長：80
notes	会社に関する補足情報。データタイプ：文字列最大長：4,000
num_employees	会社に雇用されている人数。データタイプ：数値 (整数) 最大長：40
number	このアカウントを識別する番号。データタイプ：文字列最大長：40
parent	このアカウントの親アカウントの sys_id。データタイプ：文字列テーブル:会社 [core_company]
partner	アカウントがパートナーアカウントか顧客アカウントかを示すフラグ。可能な値： true：パートナーアカウント false：顧客アカウントデータタイプ：ブールデフォルト値：false
phone	会社の主要な電話番号。データタイプ：文字列
primary	これがプライマリアカウントであるかどうかを示すフラグ。可能な値： true：プライマリアカウント false：セカンダリアカウントデータタイプ：ブールデフォルト値：false
primary_contact	アカウントの主連絡先の sys_id。データタイプ：文字列テーブル:連絡先 [customer_contact]
profits	このアカウントに対して入力された利益情報。データタイプ：数値 (通貨) 最大長：40
public_traded	このアカウントに関連付けられている会社の株式が証券取引所で公開されているかどうかを示すフラグ。可能な値： true：株式公開 false：株式非公開会社データタイプ：ブール
rank_tier	アカウントのタイプ。可能な値： blacklist その他 strategic tactical valued データタイプ：文字列最大長：40
registration_code	顧客がカスタマーポータルでログインを要求するときに使用する一意のコード。このコードは、アクセス権を付与する前に会社で顧客を検証する方法を提供します。データタイプ：文字列最大長：40
revenue_per_year	このアカウントに関連付けられている会社が生み出した収益。データタイプ：数値 (通貨) 最大長：20
state	会社が所在する都道府県。データタイプ：文字列最大長：40
stock_price	会社の株価。データタイプ：文字列最大長：40
stock_symbol	会社の銘柄記号。データタイプ：文字列最大長：40
street	会社の番地データタイプ：文字列最大長：255
sys_class_name	関連するアカウントレコードを含むテーブル。データタイプ：文字列
sys_created_by	最初にアカウントを作成したユーザー。データタイプ：文字列最大長：40
sys_created_on	アカウントが最初に作成された日時。データタイプ：文字列
sys_id	アカウントレコードの sys_id。データタイプ：文字列
sys_mod_count	アカウント情報が更新された回数。データタイプ：数値 (整数)
sys_updated_by	アカウント情報を最後に変更したユーザー。データタイプ：文字列最大長：40
sys_updated_on	アカウント情報が最後に更新された日時。データタイプ：文字列
theme	このアカウントで使用されるカスタマーポータルテーマの sys_id。データタイプ：文字列テーブル:テーマ [sys_ui_theme]
ベンダー	このアカウントに関連付けられている会社がベンダーかどうかを示すフラグ。可能な値： true：ベンダー false：ベンダーではないデータタイプ：ブールデフォルト値：false
vendor_manager	アカウントのベンダーマネージャーの sys_id のリスト。データタイプ：文字列テーブル:ユーザー [sys_user]
vendor_type	アプリケーション、ハードウェア、サービス、ソフトウェアなどのベンダーのタイプの sys_id のリスト。データタイプ：文字列テーブル:ベンダータイプ [vendor_type]
website	会社の Web サイトの URL。データタイプ：文字列最大長：1,024
zip	会社の郵便番号。データタイプ：文字列最大長：40

cURL 要求

curl "https://instance.servicenow.com/api/now/account?sysparm_limit=2&sysparm_offset=2>;rel="next" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
"result": [
  {
   "banner_image_light": "",
   "country": "USA",
   "parent": "",
   "notes": "",
   "stock_symbol": "",
   "discount": "",
   "active_escalation": "",
   "sys_updated_on": "2019-01-03 19:37:55",
   "apple_icon": "",
   "number": "ACCT0000003",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:25:17",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "BR1 3QR",
    "profits": "0",
    "phone": "+44 20 8466 9992",
    "fax_phone": "",
    "name": "Boxeo EMEA",
    "banner_text": "",
    "account_code": "~~~~3",
    "primary": "false",
    "city": "Bromley",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "3eedd08413651200042ab3173244b088",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "18 London Rd",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-EMEA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~3",
    "primary_contact": "ff66c1254fb81200025ba3618110c76e",
    "customer": "true"
  },
  {
    "banner_image_light": "",
    "country": "USA",
    "parent": "",
    "notes": "",
    "stock_symbol": "",
    "discount": "",
    "active_escalation": "",
    "sys_updated_on": "2019-01-03 19:38:04",
    "apple_icon": "",
    "number": "ACCT0000004",
    "sys_updated_by": "admin",
    "fiscal_year": "",
    "sys_created_on": "2018-12-23 05:19:24",
    "contact": "",
    "stock_price": "",
    "state": "",
    "banner_image": "",
    "sys_created_by": "admin",
    "longitude": "",
    "zip": "V5L 2G4",
    "profits": "0",
    "phone": "+1 604-255-9797",
    "fax_phone": "",
    "name": "Boxeo Canada",
    "banner_text": "",
    "account_code": "~~~~4",
    "primary": "false",
    "city": "Vancouver",
    "latitude": "",
    "sys_class_name": "customer_account",
    "manufacturer": "false",
    "account_parent": "86837a386f0331003b3c498f5d3ee4ca",
    "sys_id": "609cd80413651200042ab3173244b03e",
    "market_cap": "0",
    "num_employees": "",
    "rank_tier": "",
    "street": "1362 Venables St,, BC V5L 2G4, Canada",
    "vendor": "false",
    "lat_long_error": "",
    "theme": "",
    "vendor_type": "",
    "website": "",
    "revenue_per_year": "0",
    "publicly_traded": "false",
    "sys_mod_count": "5",
    "sys_tags": "",
    "partner": "false",
    "registration_code": "BOXEO-CANADA",
    "vendor_manager": "",
    "account_path": "~~~~1/~~~~4",
    "primary_contact": "c07424a54f781200025ba3618110c746",
    "customer": "true"
  }
 ]
}

アカウント - GET /now/account/{id}

指定されたカスタマーサービス管理 (CSM) アカウントを取得します。