--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP ft:publication_title : - オーストラリア API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # パーティ管理オープン API # パーティ管理オープン API {#ariaid-title1} * リリースバージョン: Australia * * 更新日 2026年03月12日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：165分パーティ管理オープン API は、コンシューマー、アカウント、連絡先など、企業との関係を持つパーティを管理するためのエンドポイントを提供します。この API を使用して、コンシューマー \[csm_consumer\]、アカウント \[customer_account\]、および連絡先 \[customer_contact\] テーブルからデータを作成、更新、および取得します。パーティ管理オープン API は、TM フォーラムパーティ管理 API REST 仕様のServiceNow®実装です。この実装は、 [TMF632 Party Management API Conformance Profile v5.0.0 -- TM フォーラム](https://www.tmforum.org/resources/reference/tmf632b-party-management-api-conformance-profile-v5-0-0/)、2025 年 6 月に基づいています。パーティ管理オープン API は、TM フォーラムによって適合性認定を受けています。この API は sn_tmf_api 名前空間内で提供されます。呼び出し元ユーザーには sn_tmf_api.party_integrator ロールが必要です。カスタマーサービスベースエンティティ (com.snc.cs_base) プラグインは、特にすべての GET 操作に必要です。この API を拡張して、必須パラメーター、要求本文の検証、追加の REST 操作、およびフィールドマッピングをカスタマイズできます。電話番号などの機密性の高いフィールドでは、更新または取得するために特別な ACL 権限が必要な場合があります。 ## パーティ管理:DELETE /api/sn_tmf_api/v1/party/individual/{id} {#ariaid-title2} コンシューマー \[csm_consumer\] テーブルと連絡先 \[customer_contact\] テーブルから指定されたレコードを無効にします。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/{api_version}/party/individual/{id} デフォルト URL: /api/sn_tmf_api/v1/party/individual/{id} ### サポートされている要求パラメーター {#partymgmt-DELETE-individual-id__entry__2}{#partymgmt-DELETE-individual-id__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | ID | 非アクティブステータスに設定するコンシューマーレコードまたは連絡先レコードのSys_idまたはexternal_id。テーブル:コンシューマー \[csm_consumer\] および連絡先 \[customer_contact\]。データタイプ：文字列 | [表 : 1. パスパラメーター] {#partymgmt-DELETE-individual-id__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#partymgmt-DELETE-individual-id__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-DELETE-individual-id__entry__16}{#partymgmt-DELETE-individual-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 4. 要求ヘッダー] {#partymgmt-DELETE-individual-id__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-DELETE-individual-id__entry__24}{#partymgmt-DELETE-individual-id__entry-200-status-code}{#partymgmt-DELETE-individual-id__entry-400-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-DELETE-individual-id__entry__30} | 名前 | 説明 | |-|-| | なし | | [ ] ### cURL 要求次の例では、指定されたレコードを削除します。 curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/individual/dca96eaa11f43110f877366201dea6c1" \ --request DELETE \ --header "Accept:application/json" \ --user 'user':'password' \ 応答本文を返しません。成功または失敗インジケーターの参照ステータスコード。 ## パーティ管理:GET /api/sn_tmf_api/v1/party/individual {#ariaid-title3} 企業との関係を持つすべての個人 (関係者) レコードのリストを取得します。特定のフィールドまたは ID で結果をフィルタリングできます。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/individual デフォルト URL: /api/sn_tmf_api/v1/party/individual ### サポートされている要求パラメーター {#partymgmt-GET-individual__entry__2}{#partymgmt-GET-individual__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 7. パスパラメーター] {#partymgmt-GET-individual__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： * @type * familyName * 性別 * givenName * href * ID * ミドルネーム * name * 国籍 * status * タイトル {#partymgmt-GET-individual__ul_cgv_ywm_3hc} データタイプ：文字列デフォルト：すべてのフィールドを返します。 | | ID | パーティ管理をsys_id別にフィルタリングします。指定されたsys_idsが応答で返されます。データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100 | | オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。データタイプ：数値デフォルト：0 | [表 : 8. クエリパラメーター] {#partymgmt-GET-individual__entry__16} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-GET-individual__entry__20}{#partymgmt-GET-individual__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 10. 要求ヘッダー] {#partymgmt-GET-individual__entry__24} | ヘッダー | 説明 | |-|-| | Content-Range | ページネーションされた呼び出しで返されるコンテンツの範囲。たとえば、offset=2 および limit=3 の場合、Content-Range ヘッダーの値はアイテム 3 から 5 です。 | | Content-Type | 応答本文のデータフォーマット。アプリケーション/json のみをサポートします。 | | 「リンク」 | クエリ結果内を移動するための次のリンクが含まれています。 * 第 1 * 最終 * 次へ * 前へ {#partymgmt-GET-individual__ul_lwd_rxm_3hc} | | X-合計-数 | ページネーションされたクエリの場合、このヘッダーはサーバーで使用可能なレコードの合計数を指定します。 | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-GET-individual__entry__34} | ステータスコード | 説明 | |-|-| | 200 | 要求が正常に処理されました。応答で返された完全なリソース (ページネーションなし)。 | | 206 | 応答で返された部分的なリソース (ページネーションあり)。 | | 400 | 要求が正しくありません。考えられる理由: * 無効なパスパラメーター * 無効な URI {#partymgmt-GET-individual__ul_dz4_5xm_3hc} | | 404 | レコードが見つかりません。クエリパラメーターに一致するレコードがテーブルに見つかりません。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-GET-individual__id_eyq_bh4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-GET-individual__ul_l4j_kw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-GET-individual__ul_zvs_1f4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-GET-individual__ul_g4d_s24_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ID | 取得するユーザー、コンシューマー、または連絡先レコードのSys_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、これはサブクラスの拡張可能な名前を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-GET-individual__ul_bws_1f4_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | パーティロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-GET-individual__ul_cws_1f4_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole | 関係者に関する情報と、レコードのコンテキストで関係者が果たす役割を表します。たとえば、ロールが `会社`の場合、 partyOrPartyRole.id には会社 \[core_company\] レコードのsys_idが含まれ、 partyOrPartyRole.name には会社の名前が含まれます。この構造により、パーティ参照とそのロールの両方が明示的に定義され、簡単に識別できるようになります。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" } | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-GET-individual__ul_ews_1f4_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。 * `ユーザーに`指定できる値: * 会社 * 部門 {#partymgmt-GET-individual__ul_fws_1f4_3hc} * `顧客`に考えられる値:アカウント * `コンシューマー`に指定できる値:ユーザー {#partymgmt-GET-individual__ul_qdd_nq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-GET-individual__ul_qbh_py3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人は非アクティブステータスです。 {#partymgmt-GET-individual__ul_hws_1f4_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [ ] {#partymgmt-GET-individual__id_eyq_bh4_3hc} ### cURL 要求インスタンス内のすべてのパーティ管理レコードのリストを取得します。 curl"http://instance.servicenow.com/api/v1/sn_tmf_api/party/individual" \ --request GET \ --header "Accept:application/json" \ --user 'user:password' 個々の連絡先パーティの応答本文。 [ { "id": "34d92aaa11f43110f877366201dea67b", "href": "api/sn_tmf_api/party/individual/34d92aaa11f43110f877366201dea67b", "name": "carlos.star", "givenName": "Carlos", "middleName": "", "familyName": "Star", "gender": "", "title": "", "partyCharacteristics": [ { "name": "notification", "value": "Enable", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "preferredLanguage", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "dateFormat", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "timeFormat", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "timeZone", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "vip", "value": false, "valueType": "boolean", "@type": "BooleanCharacteristic" }, { "name": "webServiceAccessOnly", "value": false, "valueType": "boolean", "@type": "BooleanCharacteristic" }, { "name": "source", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "eduStatus", "value": "Faculty", "valueType": "string", "@type": "StringCharacteristic" } ], "contactMedium": [ { "preferred": false, "mediumType": "email", "emailAddress": "carlos.star@example.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "mobilePhone", "phoneNumber": "", "@type": "MobilePhoneContactMedium" } ], "externalReference": [], "relatedParty": [ { "role": "Company", "partyOrPartyRole": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Startech svcs", "@type": "Organization" } }, { "role": "Department", "partyOrPartyRole": { "id": "", "name": "", "@type": "Organization" } } ], "status": "Active", "@type": "Individual", "partyOrPartyRole": { "name": "Contact", "@type": "Party" } } ] 個々のコンシューマーパーティの応答本文。 [ { "id": "168bfc6953a46210132bddeeff7b129f", "href": "api/sn_tmf_api/party/individual/168bfc6953a46210132bddeeff7b129f", "givenName": "yyyg", "middleName": "hhh", "familyName": "bhhhbjhh", "gender": "", "nationality": "", "title": "", "partyCharacteristics": [ { "name": "notes", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "user", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "notification", "value": "Enable", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "preferredLanguage", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "dateFormat", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "timeFormat", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "timeZone", "value": "", "valueType": "string", "@type": "StringCharacteristic" } ], "contactMedium": [ { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "mobilePhone", "phoneNumber": "", "@type": "MobilePhoneContactMedium" }, { "preferred": false, "mediumType": "fax", "phoneNumber": "", "@type": "FaxContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "@type": "GeographicalAddressContactMedium", "city": "ygyg", "locationId": "a39bfc6953a46210132bddeeff7b12b7", "country": "", "postCode": "hh", "stateOrProvince": "gyg", "street1": "hgg", "street2": "" } ], "externalReference": [], "relatedParty": [ { "role": "User", "partyOrPartyRole": { "id": "", "name": "", "@type": "Individual" } } ], "status": "Active", "@type": "Individual", "partyOrPartyRole": { "name": "Consumer", "@type": "Party" } } ] ## パーティ管理:GET /api/sn_tmf_api/v1/party/individual/{id} {#ariaid-title4} コンシューマー \[csm_consumer\] テーブルまたは連絡先 \[customer_contact\] テーブルから指定されたレコードを取得します。特定のフィールドで結果をフィルタリングできます。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/{api_version}/party/individual デフォルト URL: /api/sn_tmf_api/v1/party/individual ### サポートされている要求パラメーター {#partymgmt-GET-individual-id__entry__2}{#partymgmt-GET-individual-id__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | ID | 取得するコンシューマーレコードまたは連絡先レコードのSys_idまたはexternal_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | [表 : 13. パスパラメーター] {#partymgmt-GET-individual-id__entry__8} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： * @type * familyName * 性別 * givenName * href * ID * ミドルネーム * name * 国籍 * status * タイトル {#partymgmt-GET-individual-id__ul_o1v_ccn_3hc} データタイプ：文字列デフォルト:すべてのフィールドを返します | [表 : 14. クエリパラメーター] {#partymgmt-GET-individual-id__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-GET-individual-id__entry__16}{#partymgmt-GET-individual-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 16. 要求ヘッダー] {#partymgmt-GET-individual-id__entry__20} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-GET-individual-id__entry__24}{#partymgmt-GET-individual-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 18. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-GET-individual-id__table_mh2_hc4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-GET-individual-id__ul_l4j_kw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-GET-individual-id__ul_zvs_1f4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-GET-individual-id__ul_g4d_s24_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ID | 取得するユーザー、コンシューマー、または連絡先レコードのSys_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、これはサブクラスの拡張可能な名前を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-GET-individual-id__ul_bws_1f4_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | パーティロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-GET-individual-id__ul_cws_1f4_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole | 関係者に関する情報と、レコードのコンテキストで関係者が果たす役割を表します。たとえば、ロールが `会社`の場合、 partyOrPartyRole.id には会社 \[core_company\] レコードのsys_idが含まれ、 partyOrPartyRole.name には会社の名前が含まれます。この構造により、パーティ参照とそのロールの両方が明示的に定義され、簡単に識別できるようになります。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" } | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-GET-individual-id__ul_ews_1f4_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。 * `ユーザーに`指定できる値: * 会社 * 部門 {#partymgmt-GET-individual-id__ul_fws_1f4_3hc} * `顧客`に考えられる値:アカウント * `コンシューマー`に指定できる値:ユーザー {#partymgmt-GET-individual-id__ul_qdd_nq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-GET-individual-id__ul_qbh_py3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人は非アクティブステータスです。 {#partymgmt-GET-individual-id__ul_hws_1f4_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [ ] {#partymgmt-GET-individual-id__table_mh2_hc4_3hc} ### cURL 要求指定されたレコード `12345` をテーブルから取得します。 curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual/12345" \ --request GET \ --header "Accept:application/json" \ --user 'user':'password' \ 応答本文。 { "id": "12345", "givenName": "JohnTest6", "middleName": "A.", "familyName": "Doe", "gender": "male", "nationality": "American", "title": "Mr", "contactMedium": [ { "preferred": true, "mediumType": "email", "emailAddress": "john.doe18723@example.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "mobilePhone", "phoneNumber": "+1-202-555-0198", "@type": "PhoneContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "+1-202-555-0198", "@type": "BusinessPhoneContactMedium" }, { "preferred":false, "mediumType":"faxPhone", "phoneNumber":"123456789", "@type":"FaxContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "+1-202-555-0198", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "@type": "GeographicAddressContactMedium", "locationId":"25ab9e240a0a0bb3009eb9ef8dd0a2c0", "city": "Town", "country": "USA", "postCode": "07960", "stateOrProvince": "New Jersey", "street1": "1820 Harris Houston Road, Charlotte", "street2": "East Tower - 10th Floor" }, { "preferred": false, "mediumType": "postalAddress", "@type": "GeographicAddressContactMedium", "locationId":"25aba17a0a0a0bb3007efd809d6e695c", "city": "Webster", "country": "USA", "postCode": "76022", "stateOrProvince": "TN", "street1": "17077 Texas Avenue, Webster", "street2": "East Tower - 11th Floor" } ], "externalReference": [ { "externalIdentifierType": "facebook", "id": "http://facebook.com/johndoe" } ], "partyCharacteristic": [ { "name": "notes", "value": "notes about the consumer", "valueType": "string", "@type": "string" }, { "name": "dateFormat", "value": "dd-mm-yyyy", "valueType": "string", "@type": "string" }, { "name": "timeformat", "value": "hh.mm.ss (12 hour)", "valueType": "string", "@type": "string" }, { "name": "notification", "value": "Enable", "valueType": "string", "@type": "string" } ], "relatedParty": [ { "role": "User", "partyOrPartyRole": { "id": "36901a6381116a50f8776cfcbee15f3c", "name": "Hr", "@type": "Individual" } } ], "status": "active", "@type": "Individual", "partyOrPartyRole": { "role": "Consumer", "@type":"Party" } } ## パーティ管理 -- GET/api/ sn_tmf_api/v1/party/organization/{id} {#ariaid-title5} アカウント \[customer_account\] テーブルから指定されたレコードを取得します。特定のフィールドまたは ID で結果をフィルタリングできます。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/organization/{id} デフォルト URL: /api/sn_tmf_api/v1/party/organization/{id} ### サポートされている要求パラメーター {#partymgmt-GET-organization-id__entry__2}{#partymgmt-GET-organization-id__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | ID | 取得する会社またはアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] または会社 \[csm_company\] データタイプ：文字列 | [表 : 19. パスパラメーター] {#partymgmt-GET-organization-id__entry__8} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： * @type * href * ID * legalName * name * status * 取引名 {#partymgmt-GET-organization-id__ul_irf_5mn_3hc} データタイプ：文字列デフォルト:すべてのフィールドを返します | | ID | パーティ管理をsys_id別にフィルタリングします。指定されたsys_idsが応答で返されます。データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100 | | オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0 | [表 : 20. クエリパラメーター] {#partymgmt-GET-organization-id__entry__18} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (XML または JSON)] ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-GET-organization-id__entry__22}{#partymgmt-GET-organization-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 22. 要求ヘッダー] {#partymgmt-GET-organization-id__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-GET-organization-id__entry__30}{#partymgmt-GET-organization-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 24. ステータスコード] ### 応答本文のパラメーター (JSON または XML) ### 応答本文のパラメーター (JSON または XML) {#partymgmt-GET-organization-id__section_r5x_5k4_3hc} {#partymgmt-GET-organization-id__table_edn_qnn_3hc__entry__2} | 名前 | 説明 | |-|-| | @type | この値は常に `[組織]` です。データタイプ：文字列 | | contactMedium | 関係者に連絡するための手段のリスト。連絡媒体は、個人や組織などの関係者とコミュニケーションを取ったり、連絡を取ったりする方法を表します。たとえば、その関係者に関連付けられたチャネルや連絡方法などです。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 接触媒体のタイプ。連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-GET-organization-id__ul_vxy_4jn_3hc} データタイプ：文字列 | | contactMedium.city | 組織の市区町村。データタイプ：文字列 | | contactMedium.country | 組織の国。データタイプ：文字列 | | contactMedium.emailAdress | 組織連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | 場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。可能な値： * 勤務先電話 * email * ファックス電話 * homePhone * 携帯電話 * 住所 {#partymgmt-GET-organization-id__ul_lq4_fjn_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 組織連絡先の電話番号。データタイプ：文字列 | | contactMedium.postCode | 組織の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に `false` です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-GET-organization-id__ul_swk_tl4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | externalReference | 外部システム内のパーティの識別子のリスト。データタイプ：オブジェクトのアレイ "externalReference": [ { "externalIdentifierType": "String", "name": "String" } ] | | externalReference.externalIdentifierType | 外部システム内のエンティティのタイプ。データタイプ：文字列 | | externalReference.name | 外部システムまたは参照の分かりやすい名前。データタイプ：文字列 | | href | アカウントレコードへの相対リンク (URI)。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | ID | 外部エンティティアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | legalName | 組織の正式名。データタイプ：文字列 | | name | 組織の名前。データタイプ：文字列 | | partyCharacteristics | パーティが取ることができる特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、 @type はサブクラスの拡張可能名を定義します。可能な値: * ブール特性 * 整数特性 * StringArrayCharacteristic * StringCharacteristic {#partymgmt-GET-organization-id__ul_tyq_y3n_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `会社` や `アカウントなど`です。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがアカウント \[customer_account\] テーブルに属している場合、 partyOrPartyRole.role は `アカウント`に設定されます。同様に、sys_idが会社 \[core_company\] テーブルに属している場合、 partyOrPartyRole.role は `[会社`\] に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", } | | PartyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | PartyOrPartyRole.name | アカウントまたは会社のタイプを定義します。データタイプ：文字列 | | PartyOrPartyRole.role | ロールのタイプ。可能な値: * アカウント * 会社 {#partymgmt-GET-organization-id__ul_uyj_2mn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ] | | relatedParty.partyOrPartyRole | このパーティに関連するロール。データタイプ：オブジェクトのアレイ "partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。値は常に `組織です`。データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。可能な値: * 連絡先 * その他 {#partymgmt-GET-organization-id__ul_spb_5ln_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が果たすロール、またはリンク先の特定のエンティティの関係者ロール。可能な値： * 連絡先 * その他 {#partymgmt-GET-organization-id__ul_uhb_rln_3hc} データタイプ：文字列 | | status | 組織のステータスを示すフラグ。有効な値： * active:組織はアクティブです。 * 非アクティブ:組織は非アクティブです。 {#partymgmt-GET-organization-id__ul_ldr_k3n_3hc} データタイプ：ブーリアン | | 取引名 | 組織が取引に使用する名前。データタイプ：文字列 | [ ] {#partymgmt-GET-organization-id__table_edn_qnn_3hc} ### cURL 要求次の GET 呼び出しは、指定されたパーティ管理組織レコードのフィールドを sys_id 12345 で返します。 curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization/12345" \ --request GET \ --header "Accept:application/json" \ --user 'user':'password' \ 応答本文。 { "id": "2154376", "name": "Advances Super Computing", "href": "api/sn_tmf_api/party/organization/2154376", "legalName": "Hello", "tradingName": "World", "contactMedium": [ { "preferred": "false", "mediumType": "email", "@type": "EmailContactMedium", "emailAddress": "user@servicenow.com" }, { "preferred": "false", "mediumType": "phone", "@type": "PhoneContactMedium", "phone": "(555) 555-5555" }, { "preferred": "false", "mediumType": "faxPhone", "@type": "FaxPhoneContactMedium", "fax_phone": "" } ], "externalReference": [ { "externalIdentifierType": "Facebook", "name": "facebook.com" }, { "externalIdentifierType": "Twitter", "name": "twitter.com" } ], "partyCharacteristic": [ { "name": "notes", "value": "efdxcjkn ", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "registrationCode", "value": "23456789", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "accountCode", "value": "####30", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "identificationNumber", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "taxId", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "industry", "value": "", "valueType": "choice", "@type": "StringCharacteristic" }, { "name": "numEmployees", "value": "", "valueType": "integer", "@type": "IntergerCharacteristic" }, { "name": "rankTier", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "publiclyTraded", "value": "false", "valueType": "boolean", "@type": "BooleanCharacteristic" }, { "name": "stockSymbol", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "stockPrice", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "vendorType", "value": "Services, Applications", "valueType": "list", "@type": "StringArrayCharacteristic" }, { "name": "marketCap", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "profits", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "revenuePerYear", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "website", "value": "sdfgh.com", "valueType": "string", "@type": "StringCharacteristic" } ], "relatedParty": [ { "role": "primary", "partyOrPartyRole": { "@type": "Organization", "id": "b88d14843bc02300bfe04d72f3efc4cd", "name": "Amy Chen" } }, { "role": "other", "partyOrPartyRole": { "@type": "Organization", "id": "016b7a36ff14a610f8dfffffffffffcb", "name": "Kutty" } }, { "role": "other", "partyOrPartyRole": { "@type": "Organization", "id": "e8bb9d1aff94a210f8dfffffffffff1d", "name": "World" } } ], "organizationChildRelationship": [ { "relationshipType": "partner_account", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Startech svcs", "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674", "@type": "Organization" } }, { "relationshipType": "New type", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Startech svcs", "href": "api/sn_tmf_api/party/organization/9e2fd2ee11b43110f877366201dea674", "@type": "Organization" } }, { "relationshipType": "child", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Startech svcs", "href": "api/sn_tmf_api/party/organization/null", "@type": "Organization" } } ], "organizationParentRelationship": { "relationshipType": "parent", "organization": { "id": "ffc68911c35420105252716b7d40dd55", "name": "Funco Intl", "href": "undefinedffc68911c35420105252716b7d40dd55", "@type": "Organization" } }, "status": "inActive", "@type": "Organization", "partyOrPartyRole": { "name": "customer_partner_vendor_manufacturer", "role": "Account", "@type": "Party" } } ## パーティ管理:GET /api/sn_tmf_api/v1/party/organization {#ariaid-title6} 会社 \[core_company\] テーブルとアカウント \[customer_account\] テーブルから組織レベルのパーティレコードを取得します。特定のフィールドまたは ID で結果をフィルタリングできます。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/organization デフォルト URL: /api/sn_tmf_api/v1/party/organization ### サポートされている要求パラメーター {#partymgmt-GET-organization__entry__2}{#partymgmt-GET-organization__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 25. パスパラメーター] {#partymgmt-GET-organization__entry__6} | 名前 | 説明 | |-|-| | フィールド | 応答で返すフィールドのリスト。無効なフィールドは無視されます。有効なフィールド： * @type * href * ID * legalName * name * status * 取引名 {#partymgmt-GET-organization__ul_tpl_5hn_3hc} データタイプ：文字列デフォルト:すべてのフィールドを返します | | ID | パーティ管理をsys_id別にフィルタリングします。指定されたsys_idsが応答で返されます。データタイプ：文字列 | | limit | 返されるレコードの最大数。このレコード数を超える要求の場合は、 offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト値：20 最大:100 | | オフセット | レコードの取得を開始する開始インデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。データタイプ：数値デフォルト：0 | [表 : 26. クエリパラメーター] {#partymgmt-GET-organization__id_avm_mj4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-GET-organization__ul_j3y_jw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-GET-organization__ul_mjg_sj4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県にあるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-GET-organization__ul_ojg_sj4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、このパラメーターはサブクラスの拡張可能名を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-GET-organization__ul_bff_czm_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | ロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-GET-organization__ul_ygw_2bn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者と関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-GET-organization__ul_crl_s1n_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | パーティ管理またはパーティロール管理システム内のリンクされたエンティティの ID。 * ユーザーに指定できる値: * `会社` * `部門` {#partymgmt-GET-organization__ul_k42_p1n_3hc} * 顧客に考えられる値: `アカウント` * コンシューマーに指定できる値: `ユーザー` {#partymgmt-GET-organization__ul_vc1_xq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-GET-organization__ul_obj_hy3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人はアクティブステータスではありません。 {#partymgmt-GET-organization__ul_z2z_4ym_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [表 : 27. 要求本文パラメーター (XML または JSON)] {#partymgmt-GET-organization__id_avm_mj4_3hc} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-GET-organization__entry__88}{#partymgmt-GET-organization__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 28. 要求ヘッダー] {#partymgmt-GET-organization__entry__92} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-GET-organization__entry__96}{#partymgmt-GET-organization__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-GET-organization__entry__100} | 名前 | 説明 | |-|-| | なし | | [ ] ### cURL 要求これにより、エンタープライズに関連するすべての組織レコードが返されます。 curl"http://instance.servicenow.com/api/sn_tmf_api/v1/party/organization" \ --request GET \ --header "Accept:application/json" \ --user 'user':'password' 応答本文。 [ { "id": "0bd6717c184da610f87765359bc696d3", "name": "SERVICENOW 144", "href": "api/sn_tmf_api/party/organization0bd6717c184da610f87765359bc696d3", "legalName": "", "tradingName": "", "contactMedium": [ { "preferred": "false", "mediumType": "email", "@type": "EmailContactMedium", "emailAddress": "user@email.com" }, { "preferred": "false", "mediumType": "phone", "@type": "PhoneContactMedium", "phone": "+1-555-555-5555" }, { "preferred": "false", "mediumType": "faxPhone", "@type": "FaxPhoneContactMedium", "fax_phone": "" } ], "externalReference": [ { "externalIdentifierType": "Instagram", "name": "" } ], "partyCharacteristic": [ { "name": "notes", "value": "Testing for update the notes", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "registrationCode", "value": "111122112211", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "accountCode", "value": "accountcode1", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "identificationNumber", "value": "", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "taxId", "value": "CTNUM1000123", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "industry", "value": "technology_services", "valueType": "choice", "@type": "StringCharacteristic" }, { "name": "numEmployees", "value": "", "valueType": "integer", "@type": "IntergerCharacteristic" }, { "name": "rankTier", "value": "rankTier", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "publiclyTraded", "value": "false", "valueType": "boolean", "@type": "BooleanCharacteristic" }, { "name": "stockSymbol", "value": "Market", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "stockPrice", "value": "1000", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "vendorType", "value": "Hardware", "valueType": "list", "@type": "StringArrayCharacteristic" }, { "name": "marketCap", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "profits", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "revenuePerYear", "value": "0", "valueType": "string", "@type": "StringCharacteristic" }, { "name": "website", "value": "", "valueType": "string", "@type": "StringCharacteristic" } ], "relatedParty": [], "organizationChildRelationship": [ { "relationshipType": "Partner Account", "organization": { "id": "396b47201841a610f87765359bc696cf", "name": "child", "href": "api/sn_tmf_api/party/organization396b47201841a610f87765359bc696cf", "@type": "Organization" } } ], "organizationParentRelationship": { "relationshipType": "parent", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Startech svcs", "href": "api/sn_tmf_api/party/organization9e2fd2ee11b43110f877366201dea674", "@type": "Organization" } }, "@type": "Organization", "partyOrPartyRole": { "name": "customer_partner", "role": "Account", "@type": "Party" } } ] ## パーティ管理:PATCH/api/sn_tmf_api/v1/party/individual/{id} {#ariaid-title7} リソース全体を置き換えることなく、コンシューマー \[csm_consumer\] テーブルまたは連絡先 \[customer_contact\] テーブルの既存の個々のパーティレコードを更新します。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/individual デフォルト URL: /api/sn_tmf_api/v1/party/individual ### サポートされている要求パラメーター {#partymgmt-PATCH-individual-id__entry__2}{#partymgmt-PATCH-individual-id__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | ID | コンシューマーまたは連絡先のSys_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | [表 : 31. パスパラメーター] {#partymgmt-PATCH-individual-id__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメーター] {#partymgmt-PATCH-individual-id__id_zhv_km4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-PATCH-individual-id__ul_j3y_jw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-PATCH-individual-id__ul_mjg_sj4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県にあるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-PATCH-individual-id__ul_ojg_sj4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、このパラメーターはサブクラスの拡張可能名を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-PATCH-individual-id__ul_bff_czm_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | ロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-PATCH-individual-id__ul_ygw_2bn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者と関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-PATCH-individual-id__ul_crl_s1n_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | パーティ管理またはパーティロール管理システム内のリンクされたエンティティの ID。 * ユーザーに指定できる値: * `会社` * `部門` {#partymgmt-PATCH-individual-id__ul_k42_p1n_3hc} * 顧客に考えられる値: `アカウント` * コンシューマーに指定できる値: `ユーザー` {#partymgmt-PATCH-individual-id__ul_vc1_xq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-PATCH-individual-id__ul_obj_hy3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人はアクティブステータスではありません。 {#partymgmt-PATCH-individual-id__ul_z2z_4ym_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [表 : 33. 要求本文パラメーター (XML または JSON)] {#partymgmt-PATCH-individual-id__id_zhv_km4_3hc} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-PATCH-individual-id__entry__84}{#partymgmt-PATCH-individual-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 34. 要求ヘッダー] {#partymgmt-PATCH-individual-id__entry__88} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-PATCH-individual-id__entry__92}{#partymgmt-PATCH-individual-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-PATCH-individual-id__id_t1b_mm4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-PATCH-individual-id__ul_l4j_kw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-PATCH-individual-id__ul_zvs_1f4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-PATCH-individual-id__ul_g4d_s24_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ID | 取得するユーザー、コンシューマー、または連絡先レコードのSys_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、これはサブクラスの拡張可能な名前を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-PATCH-individual-id__ul_bws_1f4_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | パーティロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-PATCH-individual-id__ul_cws_1f4_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole | 関係者に関する情報と、レコードのコンテキストで関係者が果たす役割を表します。たとえば、ロールが `会社`の場合、 partyOrPartyRole.id には会社 \[core_company\] レコードのsys_idが含まれ、 partyOrPartyRole.name には会社の名前が含まれます。この構造により、パーティ参照とそのロールの両方が明示的に定義され、簡単に識別できるようになります。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" } | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-PATCH-individual-id__ul_ews_1f4_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。 * `ユーザーに`指定できる値: * 会社 * 部門 {#partymgmt-PATCH-individual-id__ul_fws_1f4_3hc} * `顧客`に考えられる値:アカウント * `コンシューマー`に指定できる値:ユーザー {#partymgmt-PATCH-individual-id__ul_qdd_nq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-PATCH-individual-id__ul_qbh_py3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人は非アクティブステータスです。 {#partymgmt-PATCH-individual-id__ul_hws_1f4_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [ ] {#partymgmt-PATCH-individual-id__id_t1b_mm4_3hc} ### cURL 要求リソース全体を置き換えることなく、コンシューマー \[csm_consumer\] テーブルまたは連絡先 \[customer_contact\] テーブルの既存の個々のパーティレコードをsys_id 12345 で更新します。 curl "http://localhost:8080/api/sn_tmf_api/v1/party/Individual/12345" \ --request PATCH \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'user':'password' --data "{ \"name\": \"John.Doe\", \"givenName\": \"John\", \"middleName\": \"A.\", \"familyName\": \"Doe\", \"gender\": \"male\", \"nationality\": \"American\", \"title\": \"Mr\", \"contactMedium\": [ { \"preferred\": true, \"mediumType\": \"email\", \"emailAddress\": \"john.doe@gmail.com\", \"@type\": \"EmailContactMedium\" }, { \"preferred\": false, \"mediumType\": \"businessPhone\", \"phoneNumber\": \"+1-202-555-0188\", \"@type\": \"PhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"homePhone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"HomePhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"postalAddress\", \"@type\": \"GeographicAddressContactMedium\", \"locationId\":\"92656927259338967\", \"city\": \"Morristown\", \"country\": \"USA\", \"postCode\": \"07960\", \"stateOrProvince\": \"New Jersey\", \"street1\": \"240 Headquarters Plazza\", \"street2\": \"East Tower - 10th Floor\" } ], \"partyCharacteristic\": [ { \"name\": \"notification\", \"value\": \"enable\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"dateFormat\", \"value\": \"MM/DD/YYYY\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"timeFormat\", \"value\": \"12-hour\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"timeZone\", \"value\": \"EST\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"vip\", \"value\": true, \"valueType\": \"boolean\", \"@type\": \"string\" }, { \"name\": \"webServiceAccessOnly\", \"value\": false, \"valueType\": \"boolean\", \"@type\": \"string\" }, { \"name\": \"source\", \"value\": \"Third-party system\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"eduStatus\", \"value\": \"Graduated\", \"valueType\": \"string\", \"@type\": \"string\" } ], \"relatedParty\": [ { \"role\": \"Company\", \"partyOrPartyRole\": { \"id\": \"86c1f3193790200044e0bfc8bcbe5d95\", \"name\": \"Acme Corporation\", \"@type\": \"Organization\" } }, { \"role\": \"Department\", \"partyOrPartyRole\": { \"id\": \"c3fdd27a7b9822105e0d5494548cb6b0\", \"name\": \"Acme Corporation\", \"@type\": \"Organization\" } } ], \"status\": \"active\", \"@type\": \"Individual\", \"partyOrPartyRole\": { \"role\": \"Consumer\", \"@type\":\"Party\" } }" \ 応答本文。 { "name": "Jane Smith", "givenName": "Jane", "middleName": "B.", "familyName": "Smith", "gender": "female", "nationality": "American", "title": "Ms", "contactMedium": [ { "preferred": true, "mediumType": "email", "emailAddress": "jane.smith@example.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "mobilePhone", "phoneNumber": "+1-416-555-1234", "@type": "PhoneContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "+1-416-555-5678", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "fax", "fax": "987654321", "@type": "FaxContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "+1-416-555-4321", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "@type": "GeographicAddressContactMedium", "locationId": "03e588a17be062105e0d5494548cb68c", "city": "Toronto", "country": "Canada", "postCode": "M5H 2N2", "stateOrProvince": "Ontario", "street1": "123 Queen St W", "street2": "Suite 1500" } ], "externalReference": [ { "externalIdentifierType": "linkedin", "id": "http://linkedin.com/in/janesmith" } ], "partyCharacteristic": [ { "name": "notes", "value": "General consumer information.", "valueType": "string", "@type": "string" }, { "name": "userName", "value": "janesmith", "valueType": "string", "@type": "string" }, { "name": "vip", "value": false, "valueType": "boolean", "@type": "string" }, { "name": "source", "value": "CRM System", "valueType": "string", "@type": "string" }, { "name": "dateFormat", "value": "yyyy-mm-dd", "valueType": "string", "@type": "string" }, { "name": "timeformat", "value": "HH:mm:ss (24 hour)", "valueType": "string", "@type": "string" }, { "name": "notification", "value": "Disabled", "valueType": "string", "@type": "string" } ], "relatedParty": [ { "role": "User", "partyOrPartyRole": { "id": "c456def03710200044e0bfc8bcbe5d99", "name": "Global Corp", "@type": "Individual" } } ], "status": "active", "@type": "Individual", "partyOrPartyRole": { "role": "Consumer", "@type": "Party" }, "warning": [ "relatedParty[0] is incorrect. User does not exist" ] } ## パーティ管理:PATCH /api/sn_tmf_api/v1/party/organization/{id} {#ariaid-title8} リソース全体を置き換えることなく、アカウント \[customer_account\] テーブルの既存の個々のパーティレコードを更新します。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/organization/{id} デフォルト URL: /api/sn_tmf_api/v1/party/organization/{id} ### サポートされている要求パラメーター {#partymgmt-PATCH-organization-id__entry__2}{#partymgmt-PATCH-organization-id__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 37. パスパラメーター] {#partymgmt-PATCH-organization-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#partymgmt-PATCH-organization-id__id_czh_nnj_jhc__entry__2} | 名前 | 説明 | |-|-| | @type | この値は常に `[組織]` です。データタイプ：文字列 | | contactMedium | 関係者に連絡するための手段のリスト。連絡媒体は、個人や組織などの関係者とコミュニケーションを取ったり、連絡を取ったりする方法を表します。たとえば、その関係者に関連付けられたチャネルや連絡方法などです。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 接触媒体のタイプ。連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-PATCH-organization-id__ul_vwf_1nj_jhc} データタイプ：文字列 | | contactMedium.city | 組織の市区町村。データタイプ：文字列 | | contactMedium.country | 組織の国。データタイプ：文字列 | | contactMedium.emailAdress | 組織連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | 場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。可能な値： * 勤務先電話 * email * ファックス電話 * homePhone * 携帯電話 * 住所 {#partymgmt-PATCH-organization-id__ul_wwf_1nj_jhc} データタイプ：文字列 | | contactMedium.phoneNumber | 組織連絡先の電話番号。データタイプ：文字列 | | contactMedium.postCode | 組織の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に `false` です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-PATCH-organization-id__ul_xwf_1nj_jhc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | externalReference | 外部システム内のパーティの識別子のリスト。データタイプ：オブジェクトのアレイ "externalReference": [ { "externalIdentifierType": "String", "name": "String" } ] | | externalReference.externalIdentifierType | 外部システム内のエンティティのタイプ。データタイプ：文字列 | | externalReference.name | 外部システムまたは参照の分かりやすい名前。データタイプ：文字列 | | href | アカウントレコードへの相対リンク (URI)。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | ID | 外部エンティティアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | legalName | 組織の正式名。データタイプ：文字列 | | name | 組織の名前。データタイプ：文字列 | | partyCharacteristics | パーティが取ることができる特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、 @type はサブクラスの拡張可能名を定義します。可能な値: * ブール特性 * 整数特性 * StringArrayCharacteristic * StringCharacteristic {#partymgmt-PATCH-organization-id__ul_ywf_1nj_jhc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `会社` や `アカウントなど`です。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがアカウント \[customer_account\] テーブルに属している場合、 partyOrPartyRole.role は `アカウント`に設定されます。同様に、sys_idが会社 \[core_company\] テーブルに属している場合、 partyOrPartyRole.role は `[会社`\] に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", } | | PartyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | PartyOrPartyRole.name | アカウントまたは会社のタイプを定義します。データタイプ：文字列 | | PartyOrPartyRole.role | ロールのタイプ。可能な値: * アカウント * 会社 {#partymgmt-PATCH-organization-id__ul_zwf_1nj_jhc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ] | | relatedParty.partyOrPartyRole | このパーティに関連するロール。データタイプ：オブジェクトのアレイ "partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。値は常に `組織です`。データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。可能な値: * 連絡先 * その他 {#partymgmt-PATCH-organization-id__ul_axf_1nj_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が果たすロール、またはリンク先の特定のエンティティの関係者ロール。可能な値： * 連絡先 * その他 {#partymgmt-PATCH-organization-id__ul_bxf_1nj_jhc} データタイプ：文字列 | | status | 組織のステータスを示すフラグ。有効な値： * active:組織はアクティブです。 * 非アクティブ:組織は非アクティブです。 {#partymgmt-PATCH-organization-id__ul_cxf_1nj_jhc} データタイプ：ブーリアン | | 取引名 | 組織が取引に使用する名前。データタイプ：文字列 | [表 : 39. 要求本文パラメーター (XML または JSON)] {#partymgmt-PATCH-organization-id__id_czh_nnj_jhc} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-PATCH-organization-id__entry__88}{#partymgmt-PATCH-organization-id__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 40. 要求ヘッダー] {#partymgmt-PATCH-organization-id__entry__92} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-PATCH-organization-id__entry__96}{#partymgmt-PATCH-organization-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-PATCH-organization-id__id_xzr_pm4_3hc} {#partymgmt-PATCH-organization-id__table_edn_qnn_3hc__entry__2} | 名前 | 説明 | |-|-| | @type | この値は常に `[組織]` です。データタイプ：文字列 | | contactMedium | 関係者に連絡するための手段のリスト。連絡媒体は、個人や組織などの関係者とコミュニケーションを取ったり、連絡を取ったりする方法を表します。たとえば、その関係者に関連付けられたチャネルや連絡方法などです。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 接触媒体のタイプ。連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-PATCH-organization-id__ul_vxy_4jn_3hc} データタイプ：文字列 | | contactMedium.city | 組織の市区町村。データタイプ：文字列 | | contactMedium.country | 組織の国。データタイプ：文字列 | | contactMedium.emailAdress | 組織連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | 場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。可能な値： * 勤務先電話 * email * ファックス電話 * homePhone * 携帯電話 * 住所 {#partymgmt-PATCH-organization-id__ul_lq4_fjn_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 組織連絡先の電話番号。データタイプ：文字列 | | contactMedium.postCode | 組織の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に `false` です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-PATCH-organization-id__ul_swk_tl4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | externalReference | 外部システム内のパーティの識別子のリスト。データタイプ：オブジェクトのアレイ "externalReference": [ { "externalIdentifierType": "String", "name": "String" } ] | | externalReference.externalIdentifierType | 外部システム内のエンティティのタイプ。データタイプ：文字列 | | externalReference.name | 外部システムまたは参照の分かりやすい名前。データタイプ：文字列 | | href | アカウントレコードへの相対リンク (URI)。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | ID | 外部エンティティアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | legalName | 組織の正式名。データタイプ：文字列 | | name | 組織の名前。データタイプ：文字列 | | partyCharacteristics | パーティが取ることができる特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、 @type はサブクラスの拡張可能名を定義します。可能な値: * ブール特性 * 整数特性 * StringArrayCharacteristic * StringCharacteristic {#partymgmt-PATCH-organization-id__ul_tyq_y3n_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `会社` や `アカウントなど`です。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがアカウント \[customer_account\] テーブルに属している場合、 partyOrPartyRole.role は `アカウント`に設定されます。同様に、sys_idが会社 \[core_company\] テーブルに属している場合、 partyOrPartyRole.role は `[会社`\] に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", } | | PartyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | PartyOrPartyRole.name | アカウントまたは会社のタイプを定義します。データタイプ：文字列 | | PartyOrPartyRole.role | ロールのタイプ。可能な値: * アカウント * 会社 {#partymgmt-PATCH-organization-id__ul_uyj_2mn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ] | | relatedParty.partyOrPartyRole | このパーティに関連するロール。データタイプ：オブジェクトのアレイ "partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。値は常に `組織です`。データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。可能な値: * 連絡先 * その他 {#partymgmt-PATCH-organization-id__ul_spb_5ln_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が果たすロール、またはリンク先の特定のエンティティの関係者ロール。可能な値： * 連絡先 * その他 {#partymgmt-PATCH-organization-id__ul_uhb_rln_3hc} データタイプ：文字列 | | status | 組織のステータスを示すフラグ。有効な値： * active:組織はアクティブです。 * 非アクティブ:組織は非アクティブです。 {#partymgmt-PATCH-organization-id__ul_ldr_k3n_3hc} データタイプ：ブーリアン | | 取引名 | 組織が取引に使用する名前。データタイプ：文字列 | [ ] {#partymgmt-PATCH-organization-id__table_edn_qnn_3hc} ### cURL 要求これにより、パーティ管理組織レコードの指定されたフィールドが返されます。 curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \ --request PATCH\ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'user':'password' \ --data "{ \"name\": \"SERVICENOW 144\", \"legalName\": \"Acme Corp Ltd.\", \"tradingName\": \"Acme Inc.\", \"contactMedium\": [ { \"preferred\": true, \"mediumType\": \"email\", \"emailAddress\": \"athammhd@email.com\", \"@type\": \"EmailContactMedium\" }, { \"preferred\": false, \"mediumType\": \"phone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"PhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"businessPhone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"BusinessPhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"homePhone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"HomePhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"postalAddress\", \"validFor\": { \"startDateTime\": \"2017-03-15T07:49:25.246Z\" }, \"@type\": \"GeographicAddressContactMedium\", \"city\": \"chennai\", \"country\": \"INDIA\", \"postCode\": \"608001\", \"stateOrProvince\": \"tamil nadu\", \"street1\": \"samcon street\", \"street2\": \"adyar,chennai\" } ], \"externalReference\": [ { \"externalIdentifierType\": \"Instagram\", \"id\": \"Instagram\" } ], \"partyCharacteristic\": [ { \"name\": \"notes\", \"value\": \"Testing for update the notes\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"customer\", \"value\": \"true\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"registrationCode\", \"value\": \"001\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"vendorType\", \"value\": [\"Hardware\"], \"valueType\": \"array\", \"@type\": \"StringArrayCharacteristic\" }, { \"name\": \"industry\", \"value\": \"technology_services\", \"valueType\": \"choice\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"taxId\", \"value\": \"CTNUM1000123\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"numEmployees\", \"value\": \"EMP1000\", \"valueType\": \"integer\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"rankTier\", \"value\": \"rankTier\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"publiclyTraded\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"stockSymbol\", \"value\": \"Market\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"stockPrice\", \"value\": \"1000\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"vendor\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"manufacturer\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"marketCap\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"profits\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"revenuePerYear\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" } ], \"relatedParty\": [ { \"role\": \"primaryContact\", \"partyOrPartyRole\": { \"id\": \"eaf68911c35420105252716b7d40ddde\", \"name\": \"John Doe\", \"@type\": \"Individual\" } }, { \"role\": \"other\", \"partyOrPartyRole\": { \"id\": \"776a22ea11f43110f877366201dea6b7\", \"name\": \"Mary Star\", \"@type\": \"Individual\" } } ], \"organizationChildRelationship\": [ { \"relationshipType\": \"partneraccount\", \"organization\": { \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\", \"name\": \"mhd\", \"@type\": \"Organization\" } } ], \"organizationParentRelationship\": { \"relationshipType\": \"Account\", \"organization\": { \"id\": \"9e2fd2ee11b43110f877366201dea674\", \"name\": \"Global Holdings Ltd.\", \"@type\": \"Organization\" } }, \"status\": \"active\", \"@type\": \"Organization\", \"partyOrPartyRole\": { \"@type\":\"Party\", \"name\":\"Customer\", \"role\": \"Account\" } }" \ 応答本文。 { "name": "SERVICENOW 144", "legalName": "Acme Corp Ltd.", "tradingName": "Acme Inc.", "contactMedium": [ { "preferred": true, "mediumType": "email", "emailAddress": "athammhd@email.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "phone", "phoneNumber": "+1-202-555-0198", "@type": "PhoneContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "+1-202-555-0198", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "+1-202-555-0198", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "validFor": { "startDateTime": "2017-03-15T07:49:25.246Z" }, "@type": "GeographicAddressContactMedium", "city": "chennai", "country": "INDIA", "postCode": "608001", "stateOrProvince": "tamil nadu", "street1": "samcon street", "street2": "adyar,chennai" } ], "externalReference": [ { "externalIdentifierType": "Instagram", "id": "Instagram" } ], "partyCharacteristic": [ { "name": "notes", "value": "Testing for update the notes", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "customer", "value": "true", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "registrationCode", "value": "001", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "vendorType", "value": ["Hardware"], "valueType": "array", "@type": "StringArrayCharacteristic" }, { "name": "industry", "value": "technology_services", "valueType": "choice", "@type": "StringCharacteristics" }, { "name": "taxId", "value": "CTNUM1000123", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "numEmployees", "value": "EMP1000", "valueType": "integer", "@type": "StringCharacteristics" }, { "name": "rankTier", "value": "rankTier", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "publiclyTraded", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "stockSymbol", "value": "Market", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "stockPrice", "value": "1000", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "vendor", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "manufacturer", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "marketCap", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" }, { "name": "profits", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" }, { "name": "revenuePerYear", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" } ], "relatedParty": [ { "role": "primaryContact", "partyOrPartyRole": { "id": "eaf68911c35420105252716b7d40ddde", "name": "John Doe", "@type": "Individual" } }, { "role": "other", "partyOrPartyRole": { "id": "776a22ea11f43110f877366201dea6b7", "name": "Mary Star", "@type": "Individual" } } ], "organizationChildRelationship": [ { "relationshipType": "partneraccount", "organization": { "id": "0fef075b2fe06a10b79db3bf42faf31a", "name": "mhd", "@type": "Organization" } } ], "organizationParentRelationship": { "relationshipType": "Account", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Global Holdings Ltd.", "@type": "Organization" } }, "status": "active", "@type": "Organization", "partyOrPartyRole": { "@type":"Party", "name":"Customer", "role": "Account" } } ## パーティ管理:POST /api/sn_tmf_api/v1/party/individual {#ariaid-title9} コンシューマー \[csm_consumer\] テーブルまたは連絡先 \[customer_contact\] テーブルに新しい個人パーティ管理レコードを作成します。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/individual デフォルト URL: /api/sn_tmf_api/v1/party/individual ### サポートされている要求パラメーター {#partymgmt-POST-individual__entry__2}{#partymgmt-POST-individual__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 43. パスパラメーター] {#partymgmt-POST-individual__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 44. クエリパラメーター] {#partymgmt-POST-individual__id_tzm_xm4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-POST-individual__ul_j3y_jw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-POST-individual__ul_mjg_sj4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県にあるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-POST-individual__ul_ojg_sj4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、このパラメーターはサブクラスの拡張可能名を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-POST-individual__ul_bff_czm_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | ロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-POST-individual__ul_ygw_2bn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者と関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-POST-individual__ul_crl_s1n_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | パーティ管理またはパーティロール管理システム内のリンクされたエンティティの ID。 * ユーザーに指定できる値: * `会社` * `部門` {#partymgmt-POST-individual__ul_k42_p1n_3hc} * 顧客に考えられる値: `アカウント` * コンシューマーに指定できる値: `ユーザー` {#partymgmt-POST-individual__ul_vc1_xq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-POST-individual__ul_obj_hy3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人はアクティブステータスではありません。 {#partymgmt-POST-individual__ul_z2z_4ym_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [表 : 45. 要求本文パラメーター (XML または JSON)] {#partymgmt-POST-individual__id_tzm_xm4_3hc} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-POST-individual__entry__82}{#partymgmt-POST-individual__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 46. 要求ヘッダー] {#partymgmt-POST-individual__entry__86} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-POST-individual__entry__90}{#partymgmt-POST-individual__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 48. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#partymgmt-POST-individual__id_vql_zm4_3hc__entry__2} | 名前 | 説明 | |-|-| | contactMedium | 関係者に連絡するための手段のリスト。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-POST-individual__ul_l4j_kw3_jhc} データタイプ：文字列 | | contactMedium.city | 個人の市区町村。データタイプ：文字列 | | contactMedium.country | 個人の国。データタイプ：文字列 | | contactMedium.emailAddress | 連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | パーティーの場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。使用されている連絡先チャネルの種類を指定するビジネスレベルの属性を示します。可能な値： * email * 勤務先電話 * homePhone * 携帯電話 * 住所 {#partymgmt-POST-individual__ul_zvs_1f4_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 個人の電話番号。データタイプ：文字列 | | contactMedium.postCode | 個人の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に false です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-POST-individual__ul_g4d_s24_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | familyName | 個人の名前 (姓)。データタイプ：文字列 | | 性別 | 個人の性別。データタイプ：文字列 | | givenName | 個人の名。データタイプ：文字列 | | href | ユーザー、コンシューマー、または連絡先レコードへの相対リンク。データタイプ：文字列 | | ID | 取得するユーザー、コンシューマー、または連絡先レコードのSys_id。テーブル:コンシューマー \[csm_consumer\] または連絡先 \[customer_contact\] データタイプ：文字列 | | ミドルネーム | 個人のミドルネーム。データタイプ：文字列 | | name | ユーザーまたは連絡先の個人のユーザー名。データタイプ：文字列 | | 国籍 | 個人の国籍。データタイプ：文字列 | | partyCharacteristics | パーティに関連付けられた特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String", "name": " String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、これはサブクラスの拡張可能な名前を定義します。可能な値： * StringCharacteristic * StringArrayCharacteristic * 整数特性 * ブール特性 {#partymgmt-POST-individual__ul_bws_1f4_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `ユーザー`、 `コンシューマー`、 `顧客連絡先`などです。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがコンシューマー \[csm_consumer\] テーブルに属している場合、 partyOrPartyRole.role は \[ `コンシューマー`\] に設定されます。同様に、sys_idが連絡先 \[customer_contact\] テーブルに属している場合、 partyOrPartyRole.role は `連絡先`に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "role":"String" } | | partyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | partyOrPartyRole.role | パーティロールのタイプ。可能な値： * コンシューマー * 連絡先 {#partymgmt-POST-individual__ul_cws_1f4_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "role": "String", "partyOrPartyRole": {Object} } ] | | relatedParty.partyOrPartyRole | 関係者に関する情報と、レコードのコンテキストで関係者が果たす役割を表します。たとえば、ロールが `会社`の場合、 partyOrPartyRole.id には会社 \[core_company\] レコードのsys_idが含まれ、 partyOrPartyRole.name には会社の名前が含まれます。この構造により、パーティ参照とそのロールの両方が明示的に定義され、簡単に識別できるようになります。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "id": "String", "name": "String" } | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。ユーザーに指定できる値: * 組織 * 個々 {#partymgmt-POST-individual__ul_ews_1f4_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。 * `ユーザーに`指定できる値: * 会社 * 部門 {#partymgmt-POST-individual__ul_fws_1f4_3hc} * `顧客`に考えられる値:アカウント * `コンシューマー`に指定できる値:ユーザー {#partymgmt-POST-individual__ul_qdd_nq3_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が現在のエンティティのコンテキストで果たすビジネスロール。可能な値： * 会社 (関係者がユーザーの場合) * 部門 (関係者がユーザーの場合) * アカウント (関係者が顧客の場合) * ユーザー (関係者がコンシューマーの場合) {#partymgmt-POST-individual__ul_qbh_py3_jhc} データタイプ：文字列 | | status | 個人のステータスを示すフラグ。有効な値： * active:個人はアクティブステータスです。 * 非アクティブ:個人は非アクティブステータスです。 {#partymgmt-POST-individual__ul_hws_1f4_3hc} データタイプ：ブーリアン | | タイトル | 個人の敬称または役職。例: `Dr.`、 `Mr.`、 `Ms.`)。データタイプ：文字列 | [ ] {#partymgmt-POST-individual__id_vql_zm4_3hc} ### cURL 要求パーティ管理の個々のレコードの指定されたフィールドが返されます。 curl "http://instance.servicenow.com/api/sn_tmf_api/v1/party/individual" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'user':'password' --data "{ \"id\": \"98765\", \"name\": \"Jane Smith\", \"givenName\": \"Jane\", \"middleName\": \"B.\", \"familyName\": \"Smith\", \"gender\": \"female\", \"nationality\": \"American\", \"title\": \"Ms\", \"contactMedium\": [ { \"preferred\": true, \"mediumType\": \"email\", \"emailAddress\": \"jane.smith@example.com\", \"@type\": \"EmailContactMedium\" }, { \"preferred\": false, \"mediumType\": \"mobilePhone\", \"phoneNumber\": \"+1-416-555-1234\", \"@type\": \"PhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"businessPhone\", \"phoneNumber\": \"+1-416-555-5678\", \"@type\": \"BusinessPhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"fax\", \"fax\": \"987654321\", \"@type\": \"FaxContactMedium\" }, { \"preferred\": false, \"mediumType\": \"homePhone\", \"phoneNumber\": \"+1-416-555-4321\", \"@type\": \"HomePhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"postalAddress\", \"@type\": \"GeographicAddressContactMedium\", \"locationId\": \"12345678901234567\", \"city\": \"Toronto\", \"country\": \"Canada\", \"postCode\": \"M5H 2N2\", \"stateOrProvince\": \"Ontario\", \"street1\": \"123 Queen St W\", \"street2\": \"Suite 1500\" } ], \"externalReference\": [ { \"externalIdentifierType\": \"linkedin\", \"id\": \"http://linkedin.com/in/janesmith\" } ], \"partyCharacteristic\": [ { \"name\": \"notes\", \"value\": \"General consumer information.\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"userName\", \"value\": \"janesmith\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"vip\", \"value\": false, \"valueType\": \"boolean\", \"@type\": \"string\" }, { \"name\": \"source\", \"value\": \"CRM System\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"dateFormat\", \"value\": \"yyyy-mm-dd\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"timeformat\", \"value\": \"HH:mm:ss (24 hour)\", \"valueType\": \"string\", \"@type\": \"string\" }, { \"name\": \"notification\", \"value\": \"Disabled\", \"valueType\": \"string\", \"@type\": \"string\" } ], \"relatedParty\": [ { \"role\": \"User\", \"partyOrPartyRole\": { \"id\": \"c456def03710200044e0bfc8bcbe5d99\", \"name\": \"Global Corp\", \"@type\": \"Individual\" } } ], \"status\": \"active\", \"@type\": \"Individual\", \"partyOrPartyRole\": { \"role\": \"Consumer\", \"@type\": \"Party\" } }" \ 応答本文。 { "id": "83e588a17b6062105e0d5494548cb65d", "href": "api/sn_tmf_api/party/individual/83e588a17b6062105e0d5494548cb65d", "name": "Jane Smith", "givenName": "Jane", "middleName": "B.", "familyName": "Smith", "gender": "female", "nationality": "American", "title": "Ms", "contactMedium": [ { "preferred": true, "mediumType": "email", "emailAddress": "jane.smith@example.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "mobilePhone", "phoneNumber": "+1-416-555-1234", "@type": "PhoneContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "+1-416-555-5678", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "fax", "fax": "987654321", "@type": "FaxContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "+1-416-555-4321", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "@type": "GeographicAddressContactMedium", "locationId": "03e588a17be062105e0d5494548cb68c", "city": "Toronto", "country": "Canada", "postCode": "M5H 2N2", "stateOrProvince": "Ontario", "street1": "123 Queen St W", "street2": "Suite 1500" } ], "externalReference": [ { "externalIdentifierType": "linkedin", "id": "http://linkedin.com/in/janesmith" } ], "partyCharacteristic": [ { "name": "notes", "value": "General consumer information.", "valueType": "string", "@type": "string" }, { "name": "userName", "value": "janesmith", "valueType": "string", "@type": "string" }, { "name": "vip", "value": false, "valueType": "boolean", "@type": "string" }, { "name": "source", "value": "CRM System", "valueType": "string", "@type": "string" }, { "name": "dateFormat", "value": "yyyy-mm-dd", "valueType": "string", "@type": "string" }, { "name": "timeformat", "value": "HH:mm:ss (24 hour)", "valueType": "string", "@type": "string" }, { "name": "notification", "value": "Disabled", "valueType": "string", "@type": "string" } ], "relatedParty": [ { "role": "User", "partyOrPartyRole": { "id": "c456def03710200044e0bfc8bcbe5d99", "name": "Global Corp", "@type": "Individual" } } ], "status": "active", "@type": "Individual", "partyOrPartyRole": { "role": "Consumer", "@type": "Party" }, "warning": [ "relatedParty[0] is incorrect. User does not exist" ] } ## パーティ管理:POST /api/sn_tmf_api/v1/party/organization {#ariaid-title10} アカウント \[customer_account\] テーブルに新しいパーティ組織レコードを作成します。 ### URL 形式バージョニングされた URL: /api/sn_tmf_api/v1/party/organization デフォルト URL: /api/sn_tmf_api/v1/party/organization ### サポートされている要求パラメーター {#partymgmt-POST-organization__entry__2}{#partymgmt-POST-organization__version-not_optional-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 49. パスパラメーター] {#partymgmt-POST-organization__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 50. クエリパラメーター] {#partymgmt-POST-organization__id_gby_knj_jhc__entry__2} | 名前 | 説明 | |-|-| | @type | この値は常に `[組織]` です。データタイプ：文字列 | | contactMedium | 関係者に連絡するための手段のリスト。連絡媒体は、個人や組織などの関係者とコミュニケーションを取ったり、連絡を取ったりする方法を表します。たとえば、その関係者に関連付けられたチャネルや連絡方法などです。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 接触媒体のタイプ。連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-POST-organization__ul_vwf_1nj_jhc} データタイプ：文字列 | | contactMedium.city | 組織の市区町村。データタイプ：文字列 | | contactMedium.country | 組織の国。データタイプ：文字列 | | contactMedium.emailAdress | 組織連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | 場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。可能な値： * 勤務先電話 * email * ファックス電話 * homePhone * 携帯電話 * 住所 {#partymgmt-POST-organization__ul_wwf_1nj_jhc} データタイプ：文字列 | | contactMedium.phoneNumber | 組織連絡先の電話番号。データタイプ：文字列 | | contactMedium.postCode | 組織の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に `false` です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-POST-organization__ul_xwf_1nj_jhc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | externalReference | 外部システム内のパーティの識別子のリスト。データタイプ：オブジェクトのアレイ "externalReference": [ { "externalIdentifierType": "String", "name": "String" } ] | | externalReference.externalIdentifierType | 外部システム内のエンティティのタイプ。データタイプ：文字列 | | externalReference.name | 外部システムまたは参照の分かりやすい名前。データタイプ：文字列 | | href | アカウントレコードへの相対リンク (URI)。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | ID | 外部エンティティアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | legalName | 組織の正式名。データタイプ：文字列 | | name | 組織の名前。データタイプ：文字列 | | partyCharacteristics | パーティが取ることができる特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、 @type はサブクラスの拡張可能名を定義します。可能な値: * ブール特性 * 整数特性 * StringArrayCharacteristic * StringCharacteristic {#partymgmt-POST-organization__ul_ywf_1nj_jhc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `会社` や `アカウントなど`です。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがアカウント \[customer_account\] テーブルに属している場合、 partyOrPartyRole.role は `アカウント`に設定されます。同様に、sys_idが会社 \[core_company\] テーブルに属している場合、 partyOrPartyRole.role は `[会社`\] に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", } | | PartyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | PartyOrPartyRole.name | アカウントまたは会社のタイプを定義します。データタイプ：文字列 | | PartyOrPartyRole.role | ロールのタイプ。可能な値: * アカウント * 会社 {#partymgmt-POST-organization__ul_zwf_1nj_jhc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ] | | relatedParty.partyOrPartyRole | このパーティに関連するロール。データタイプ：オブジェクトのアレイ "partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。値は常に `組織です`。データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。可能な値: * 連絡先 * その他 {#partymgmt-POST-organization__ul_axf_1nj_jhc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が果たすロール、またはリンク先の特定のエンティティの関係者ロール。可能な値： * 連絡先 * その他 {#partymgmt-POST-organization__ul_bxf_1nj_jhc} データタイプ：文字列 | | status | 組織のステータスを示すフラグ。有効な値： * active:組織はアクティブです。 * 非アクティブ:組織は非アクティブです。 {#partymgmt-POST-organization__ul_cxf_1nj_jhc} データタイプ：ブーリアン | | 取引名 | 組織が取引に使用する名前。データタイプ：文字列 | [表 : 51. 要求本文パラメーター (XML または JSON)] {#partymgmt-POST-organization__id_gby_knj_jhc} ### ヘッダー次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")を参照してください。 {#partymgmt-POST-organization__entry__88}{#partymgmt-POST-organization__accept-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 52. 要求ヘッダー] {#partymgmt-POST-organization__entry__92} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供するシンプルなステートレスアーキテクチャであり、コンピューターシステム間の通信を容易にします。")」を参照してください。 {#partymgmt-POST-organization__entry__96}{#partymgmt-POST-organization__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON または XML) ### 応答本文のパラメーター (JSON または XML) {#partymgmt-POST-organization__id_u4c_sm4_3hc} {#partymgmt-POST-organization__table_edn_qnn_3hc__entry__2} | 名前 | 説明 | |-|-| | @type | この値は常に `[組織]` です。データタイプ：文字列 | | contactMedium | 関係者に連絡するための手段のリスト。連絡媒体は、個人や組織などの関係者とコミュニケーションを取ったり、連絡を取ったりする方法を表します。たとえば、その関係者に関連付けられたチャネルや連絡方法などです。データタイプ：オブジェクトのアレイ "contactMedium": [ { "@type": "String", "city": "String", "country": "String", "emailAddress": "String", "locationId": "String", "mediumType": "String", "phoneNumber": "String", "postCode": "String", "preferred": "Boolean", "stateOrProvince": "String", "street1": "String", "street2": "String" } ] | | contactMedium.@type | 接触媒体のタイプ。連絡当事者のタイプ。オブジェクトの特定のスキーマまたはサブクラスタイプを示します。可能な値： * BusinessPhoneContactMedium:勤務先電話番号 * EmailContactMedium:メールアドレス * FaxPhoneContactMedium:ファックス番号 * GeographicAddressContactMedium:実際の住所 (番地、市区町村、都道府県、郵便番号) * HomePhoneContactMedium:自宅電話番号 * MobilePhoneContactMedium:携帯電話番号 {#partymgmt-POST-organization__ul_vxy_4jn_3hc} データタイプ：文字列 | | contactMedium.city | 組織の市区町村。データタイプ：文字列 | | contactMedium.country | 組織の国。データタイプ：文字列 | | contactMedium.emailAdress | 組織連絡先のメールアドレス。データタイプ：文字列 | | contactMedium.locationId | 場所のSys_id。テーブル:場所 \[cmn_location\] データタイプ：文字列 | | contactMedium.mediumType | 接触媒体のタイプ。可能な値： * 勤務先電話 * email * ファックス電話 * homePhone * 携帯電話 * 住所 {#partymgmt-POST-organization__ul_lq4_fjn_3hc} データタイプ：文字列 | | contactMedium.phoneNumber | 組織連絡先の電話番号。データタイプ：文字列 | | contactMedium.postCode | 組織の郵便番号。データタイプ：文字列 | | contactMedium.preferred | この値は常に `false` です。データタイプ：ブーリアン | | contactMedium.stateOrProvince | 場所が州または都道府県からのものであるかどうかを示します。可能な値： * 状況 * 都道府県 {#partymgmt-POST-organization__ul_swk_tl4_3hc} データタイプ：文字列 | | contactMedium.street1 | 通りの説明。データタイプ：文字列 | | contactMedium.street2 | 補完的な道路の説明。データタイプ：文字列 | | externalReference | 外部システム内のパーティの識別子のリスト。データタイプ：オブジェクトのアレイ "externalReference": [ { "externalIdentifierType": "String", "name": "String" } ] | | externalReference.externalIdentifierType | 外部システム内のエンティティのタイプ。データタイプ：文字列 | | externalReference.name | 外部システムまたは参照の分かりやすい名前。データタイプ：文字列 | | href | アカウントレコードへの相対リンク (URI)。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | ID | 外部エンティティアカウントレコードのSys_id。テーブル:アカウント \[customer_account\] データタイプ：文字列 | | legalName | 組織の正式名。データタイプ：文字列 | | name | 組織の名前。データタイプ：文字列 | | partyCharacteristics | パーティが取ることができる特性のリスト。データタイプ：オブジェクトのアレイ "partyCharacteristics": [ { "@type": "String" "name": "String", "value": "String", "valueType": "String" } ] | | partyCharacteristics.@type | サブクラス化する場合、 @type はサブクラスの拡張可能名を定義します。可能な値: * ブール特性 * 整数特性 * StringArrayCharacteristic * StringCharacteristic {#partymgmt-POST-organization__ul_tyq_y3n_3hc} データタイプ：文字列 | | partyCharacteristics.name | パーティ特性の名前。データタイプ：文字列 | | partyCharacteristics.value | パーティ特性の値。データタイプ：文字列 | | partyCharacteristics.valueType | 特性の値のデータタイプ。データタイプ：文字列 | | partyOrPartyRole | このパーティに関連するロールは、テーブル内でパーティが作成される場所で定義されます。たとえば、 `会社` や `アカウントなど`です。 partyOrPartyRole 操作で取得するレコードのタイプを示します。指定されたsys_idがアカウント \[customer_account\] テーブルに属している場合、 partyOrPartyRole.role は `アカウント`に設定されます。同様に、sys_idが会社 \[core_company\] テーブルに属している場合、 partyOrPartyRole.role は `[会社`\] に設定されます。データタイプ: オブジェクト "partyOrPartyRole": { "@type": "String", "name":"String", "role":"String", } | | PartyOrPartyRole.@type | この値は常に `パーティ`です。データタイプ：文字列 | | PartyOrPartyRole.name | アカウントまたは会社のタイプを定義します。データタイプ：文字列 | | PartyOrPartyRole.role | ロールのタイプ。可能な値: * アカウント * 会社 {#partymgmt-POST-organization__ul_uyj_2mn_3hc} データタイプ：文字列 | | 関連パーティー | この関係者に関連する関係者または関係者ロールのリスト。データタイプ：オブジェクトのアレイ "relatedParty": [ { "partyOrPartyRole": {Object}, "role": "String" } ] | | relatedParty.partyOrPartyRole | このパーティに関連するロール。データタイプ：オブジェクトのアレイ "partyOrPartyRole": [ { "@type": "String", "id": "String", "name": "String", } ] | | relatedParty.partyOrPartyRole.@type | 関係者のタイプ。値は常に `組織です`。データタイプ：文字列 | | relatedParty.partyOrPartyRole.id | 関係者の sys_id。可能な値: * 連絡先 * その他 {#partymgmt-POST-organization__ul_spb_5ln_3hc} データタイプ：文字列 | | relatedParty.partyOrPartyRole.name | 関係者の名前。データタイプ：文字列 | | relatedParty.role | 関係者が果たすロール、またはリンク先の特定のエンティティの関係者ロール。可能な値： * 連絡先 * その他 {#partymgmt-POST-organization__ul_uhb_rln_3hc} データタイプ：文字列 | | status | 組織のステータスを示すフラグ。有効な値： * active:組織はアクティブです。 * 非アクティブ:組織は非アクティブです。 {#partymgmt-POST-organization__ul_ldr_k3n_3hc} データタイプ：ブーリアン | | 取引名 | 組織が取引に使用する名前。データタイプ：文字列 | [ ] {#partymgmt-POST-organization__table_edn_qnn_3hc} ### cURL 要求これにより、パーティ管理組織レコードの指定されたフィールドが返されます。 curl "http://instance.service-now.com/api/sn_tmf_api/v1/party/organization" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user 'user':'password' --data "{ \"name\": \"SERVICENOW 144\", \"legalName\": \"Acme Corp Ltd.\", \"tradingName\": \"Acme Inc.\", \"contactMedium\": [ { \"preferred\": true, \"mediumType\": \"email\", \"emailAddress\": \"athammhd@email.com\", \"@type\": \"EmailContactMedium\" }, { \"preferred\": false, \"mediumType\": \"phone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"PhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"businessPhone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"BusinessPhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"homePhone\", \"phoneNumber\": \"+1-202-555-0198\", \"@type\": \"HomePhoneContactMedium\" }, { \"preferred\": false, \"mediumType\": \"postalAddress\", \"validFor\": { \"startDateTime\": \"2017-03-15T07:49:25.246Z\" }, \"@type\": \"GeographicAddressContactMedium\", \"city\": \"chennai\", \"country\": \"INDIA\", \"postCode\": \"608001\", \"stateOrProvince\": \"tamil nadu\", \"street1\": \"samcon street\", \"street2\": \"adyar,chennai\" } ], \"externalReference\": [ { \"externalIdentifierType\": \"Instagram\", \"id\": \"Instagram\" } ], \"partyCharacteristic\": [ { \"name\": \"notes\", \"value\": \"Testing for update the notes\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"customer\", \"value\": \"true\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"registrationCode\", \"value\": \"001\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"vendorType\", \"value\": [\"Hardware\"], \"valueType\": \"array\", \"@type\": \"StringArrayCharacteristic\" }, { \"name\": \"industry\", \"value\": \"technology_services\", \"valueType\": \"choice\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"taxId\", \"value\": \"CTNUM1000123\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"numEmployees\", \"value\": \"EMP1000\", \"valueType\": \"integer\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"rankTier\", \"value\": \"rankTier\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"publiclyTraded\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"stockSymbol\", \"value\": \"Market\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"stockPrice\", \"value\": \"1000\", \"valueType\": \"string\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"vendor\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"manufacturer\", \"value\": \"false\", \"valueType\": \"boolean\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"marketCap\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"profits\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" }, { \"name\": \"revenuePerYear\", \"value\": \"0\", \"valueType\": \"currency\", \"@type\": \"StringCharacteristics\" } ], \"relatedParty\": [ { \"role\": \"primaryContact\", \"partyOrPartyRole\": { \"id\": \"eaf68911c35420105252716b7d40ddde\", \"name\": \"John Doe\", \"@type\": \"Individual\" } }, { \"role\": \"other\", \"partyOrPartyRole\": { \"id\": \"776a22ea11f43110f877366201dea6b7\", \"name\": \"Mary Star\", \"@type\": \"Individual\" } } ], \"organizationChildRelationship\": [ { \"relationshipType\": \"partneraccount\", \"organization\": { \"id\": \"0fef075b2fe06a10b79db3bf42faf31a\", \"name\": \"mhd\", \"@type\": \"Organization\" } } ], \"organizationParentRelationship\": { \"relationshipType\": \"Account\", \"organization\": { \"id\": \"9e2fd2ee11b43110f877366201dea674\", \"name\": \"Global Holdings Ltd.\", \"@type\": \"Organization\" } }, \"status\": \"active\", \"@type\": \"Organization\", \"partyOrPartyRole\": { \"@type\":\"Party\", \"name\":\"Customer\", \"role\": \"Account\" } }" \ 応答本文。 { "name": "SERVICENOW 144", "legalName": "Acme Corp Ltd.", "tradingName": "Acme Inc.", "contactMedium": [ { "preferred": true, "mediumType": "email", "emailAddress": "athammhd@email.com", "@type": "EmailContactMedium" }, { "preferred": false, "mediumType": "phone", "phoneNumber": "+1-202-555-0198", "@type": "PhoneContactMedium" }, { "preferred": false, "mediumType": "businessPhone", "phoneNumber": "+1-202-555-0198", "@type": "BusinessPhoneContactMedium" }, { "preferred": false, "mediumType": "homePhone", "phoneNumber": "+1-202-555-0198", "@type": "HomePhoneContactMedium" }, { "preferred": false, "mediumType": "postalAddress", "validFor": { "startDateTime": "2017-03-15T07:49:25.246Z" }, "@type": "GeographicAddressContactMedium", "city": "chennai", "country": "INDIA", "postCode": "608001", "stateOrProvince": "tamil nadu", "street1": "samcon street", "street2": "adyar,chennai" } ], "externalReference": [ { "externalIdentifierType": "Instagram", "id": "Instagram" } ], "partyCharacteristic": [ { "name": "notes", "value": "Testing for update the notes", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "customer", "value": "true", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "registrationCode", "value": "001", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "vendorType", "value": ["Hardware"], "valueType": "array", "@type": "StringArrayCharacteristic" }, { "name": "industry", "value": "technology_services", "valueType": "choice", "@type": "StringCharacteristics" }, { "name": "taxId", "value": "CTNUM1000123", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "numEmployees", "value": "EMP1000", "valueType": "integer", "@type": "StringCharacteristics" }, { "name": "rankTier", "value": "rankTier", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "publiclyTraded", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "stockSymbol", "value": "Market", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "stockPrice", "value": "1000", "valueType": "string", "@type": "StringCharacteristics" }, { "name": "vendor", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "manufacturer", "value": "false", "valueType": "boolean", "@type": "StringCharacteristics" }, { "name": "marketCap", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" }, { "name": "profits", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" }, { "name": "revenuePerYear", "value": "0", "valueType": "currency", "@type": "StringCharacteristics" } ], "relatedParty": [ { "role": "primaryContact", "partyOrPartyRole": { "id": "eaf68911c35420105252716b7d40ddde", "name": "John Doe", "@type": "Individual" } }, { "role": "other", "partyOrPartyRole": { "id": "776a22ea11f43110f877366201dea6b7", "name": "Mary Star", "@type": "Individual" } } ], "organizationChildRelationship": [ { "relationshipType": "partneraccount", "organization": { "id": "0fef075b2fe06a10b79db3bf42faf31a", "name": "mhd", "@type": "Organization" } } ], "organizationParentRelationship": { "relationshipType": "Account", "organization": { "id": "9e2fd2ee11b43110f877366201dea674", "name": "Global Holdings Ltd.", "@type": "Organization" } }, "status": "active", "@type": "Organization", "partyOrPartyRole": { "@type":"Party", "name":"Customer", "role": "Account" } }