機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 世帯
  4. プライマリ住所

プライマリ住所の作成

post

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress

リクエスト

パス・パラメータ
  • 世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
  • 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
リクエスト本文 - application/json ()
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ: object
ソースを表示
  • タイトル: Addressee
    最大長: 360
    世帯の受取人。
  • タイトル: Additional Address Element 1
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 2
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 3
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 4
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 5
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Address Line 1
    最大長: 240
    住所の最初の行。
  • タイトル: Address Line 2
    最大長: 240
    住所の2行目。
  • タイトル: Address Line 3
    最大長: 240
    住所の3行目。
  • タイトル: Address Line 4
    最大長: 240
    住所の4行目。
  • タイトル: Address Lines Phonetic
    最大長: 560
    漢字住所行の表記(日本で使用)。
  • タイトル: Site Number
    最大長: 30
    住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プレフィクスは、プロファイル・オプションZCA_PUID_PREFIXで定義され、内部で生成された一意の順序番号と連結されます。
  • タイトル: Building
    最大長: 240
    特定の住所の特定の建物名または番号。
  • タイトル: City
    最大長: 60
    プライマリ住所の市区町村要素。
  • タイトル: Comments
    最大長: 2000
    プライマリ住所のユーザー指定コメント。
  • デフォルト値: 0
    プライマリ住所レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • 最大長: 15
    企業通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Country
    最大長: 2
    プライマリ住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
  • タイトル: County
    最大長: 60
    プライマリ住所の郡要素。
  • 最大長: 30
    住所に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    プライマリ住所に関連付けられた通貨コード。 デフォルト値は、プロファイル・オプションZCA_COMMON_CORPORATE_CURRENCYで指定された値です。
  • タイトル: Validated Date
    住所が最後に検証された日付。
  • タイトル: Delete Primary Address
    プライマリ住所を削除するかどうかを示します。 値がTrueの場合、プライマリ住所は削除されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
  • タイトル: Description
    最大長: 2000
    事業所の詳細な摘要。
  • タイトル: Don't Validate
    最大長: 1
    現在の検証に関係なく、特定の事業所が住所検証に適格でないことを指定するインジケータです。
  • タイトル: To Date
    アクティブ・ステータスのプライマリ住所レコードの最終日。
  • タイトル: Floor
    最大長: 40
    建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
  • タイトル: House Type
    最大長: 30
    住所に指定された建物のタイプ。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
  • タイトル: Latitude
    住所の緯度情報。 これは、空間近接性および包含目的で使用されます。
  • タイトル: Comments
    最大長: 2000
    自由テキスト形式のレコードの追加情報。
  • タイトル: Location Directions
    最大長: 640
    ロケーションへの道順。
  • この住所の事業所レコードの一意の識別子。
  • 事業所レコードの統合キー。
  • タイトル: Location ID
    プライマリ住所の事業所レコードのシステム識別子。
  • 事業所レコードのソース・システムの名前。
  • 外部ソース・システムからの関係の一意の識別子。
  • 最大長: 1
    デフォルト値: true
    プライマリ住所の所在地レコード。
  • タイトル: Longitude
    住所の経度情報。 これは、空間近接性および包含目的で使用されます。
  • タイトル: Mail Stop
    最大長: 60
    組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
  • プライマリ住所の事業所の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • プライマリ住所のパーティ・サイトの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    これが関連オブジェクトのプライマリ住所かどうかを示します。 値がYの場合、住所はプライマリ住所です。
  • 住所が関連付けられている取引先、担当者または世帯の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
  • タイトル: Site Name
    最大長: 240
    プライマリ住所のパーティ・サイトの名前。
  • タイトル: One-Time Address
    最大長: 30
    パーティ・サイトのタイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
  • タイトル: Postal Code
    最大長: 60
    住所の郵便番号エレメントです。
  • タイトル: Postal Code Extension
    最大長: 20
    米国の郵便番号への4桁の拡張。
  • タイトル: Province
    最大長: 60
    住所の州要素。
  • タイトル: Short Description
    最大長: 240
    プライマリ住所の短い説明。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: From Date
    リソースが販売アカウントに関連付けられている日付。
  • タイトル: State
    最大長: 60
    住所の都道府県要素。
  • 最大長: 1
    デフォルト値: A
    プライマリ住所のステータスを示します。 ステータス・コードは、参照HZ_STATUSによって定義されます。
  • タイトル: Time Zone
    最大長: 64
    プライマリ住所に関連付けられたタイムゾーンのコード。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証されたかどうかを示します。 Y(検証済)、N(無効)。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はNULLに設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : households-PrimaryAddress-item-response
タイプ: object
ソースを表示
  • タイトル: Addressee
    最大長: 360
    世帯の受取人。
  • タイトル: Additional Address Element 1
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 2
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 3
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 4
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • タイトル: Additional Address Element 5
    最大長: 150
    柔軟な住所書式をサポートするための追加住所要素。
  • 読取り専用: true
    作成中に内部で生成された住所の一意の識別子。 addressId、addressnumberまたはSourceSystemおよびsourceystemreferencevalueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • タイトル: Address Line 1
    最大長: 240
    住所の最初の行。
  • タイトル: Address Line 2
    最大長: 240
    住所の2行目。
  • タイトル: Address Line 3
    最大長: 240
    住所の3行目。
  • タイトル: Address Line 4
    最大長: 240
    住所の4行目。
  • タイトル: Address Lines Phonetic
    最大長: 560
    漢字住所行の表記(日本で使用)。
  • タイトル: Site Number
    最大長: 30
    住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プレフィクスは、プロファイル・オプションZCA_PUID_PREFIXで定義され、内部で生成された一意の順序番号と連結されます。
  • タイトル: Building
    最大長: 240
    特定の住所の特定の建物名または番号。
  • タイトル: City
    最大長: 60
    プライマリ住所の市区町村要素。
  • タイトル: Comments
    最大長: 2000
    プライマリ住所のユーザー指定コメント。
  • デフォルト値: 0
    プライマリ住所レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • 最大長: 15
    企業通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Country
    最大長: 2
    プライマリ住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
  • タイトル: County
    最大長: 60
    プライマリ住所の郡要素。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • 最大長: 30
    住所に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    プライマリ住所に関連付けられた通貨コード。 デフォルト値は、プロファイル・オプションZCA_COMMON_CORPORATE_CURRENCYで指定された値です。
  • タイトル: Validated Date
    住所が最後に検証された日付。
  • タイトル: Delete Primary Address
    プライマリ住所を削除するかどうかを示します。 値がTrueの場合、プライマリ住所は削除されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
  • タイトル: Description
    最大長: 2000
    事業所の詳細な摘要。
  • タイトル: Don't Validate
    最大長: 1
    現在の検証に関係なく、特定の事業所が住所検証に適格でないことを指定するインジケータです。
  • タイトル: To Date
    アクティブ・ステータスのプライマリ住所レコードの最終日。
  • タイトル: Floor
    最大長: 40
    建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
  • タイトル: Address
    読取り専用: true
    書式設定された住所情報。
  • タイトル: Address
    読取り専用: true
    書式設定された複数の明細住所情報。
  • タイトル: House Type
    最大長: 30
    住所に指定された建物のタイプ。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン詳細。
  • タイトル: Latitude
    住所の緯度情報。 これは、空間近接性および包含目的で使用されます。
  • Links
  • タイトル: Comments
    最大長: 2000
    自由テキスト形式のレコードの追加情報。
  • タイトル: Location Directions
    最大長: 640
    ロケーションへの道順。
  • この住所の事業所レコードの一意の識別子。
  • 事業所レコードの統合キー。
  • タイトル: Location ID
    プライマリ住所の事業所レコードのシステム識別子。
  • 事業所レコードのソース・システムの名前。
  • 外部ソース・システムからの関係の一意の識別子。
  • 最大長: 1
    デフォルト値: true
    プライマリ住所の所在地レコード。
  • タイトル: Longitude
    住所の経度情報。 これは、空間近接性および包含目的で使用されます。
  • タイトル: Mail Stop
    最大長: 60
    組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
  • プライマリ住所の事業所の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • プライマリ住所のパーティ・サイトの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    これが関連オブジェクトのプライマリ住所かどうかを示します。 値がYの場合、住所はプライマリ住所です。
  • 住所が関連付けられている取引先、担当者または世帯の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
  • タイトル: Site Name
    最大長: 240
    プライマリ住所のパーティ・サイトの名前。
  • タイトル: One-Time Address
    最大長: 30
    パーティ・サイトのタイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
  • タイトル: Postal Code
    最大長: 60
    住所の郵便番号エレメントです。
  • タイトル: Postal Code Extension
    最大長: 20
    米国の郵便番号への4桁の拡張。
  • タイトル: Province
    最大長: 60
    住所の州要素。
  • タイトル: Short Description
    最大長: 240
    プライマリ住所の短い説明。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: From Date
    リソースが販売アカウントに関連付けられている日付。
  • タイトル: State
    最大長: 60
    住所の都道府県要素。
  • 最大長: 1
    デフォルト値: A
    プライマリ住所のステータスを示します。 ステータス・コードは、参照HZ_STATUSによって定義されます。
  • タイトル: Time Zone
    最大長: 64
    プライマリ住所に関連付けられたタイムゾーンのコード。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証されたかどうかを示します。 Y(検証済)、N(無効)。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はNULLに設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
リンク
CountriesLOV
パラメータ:
  • ファインダ: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
米国および英国など、プライマリ住所の国コードの値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: 国、ターゲット属性: TerritoryCode
  • 表示属性: TerritoryShortName
HouseTypeLookupLOV
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
ハウス・ボートやトレーラなど、世帯の建物タイプの値リストです。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: HouseType;ターゲット属性: LookupCode
  • 表示属性: 意味
トップに戻る

例:

cURLコマンド

次の例では、cURLを使用してRESTリソースに対するポスト・リクエストを発行して、プライマリ・アドレスを作成する方法を示します。 

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_336627/child/PrimaryAddress/

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "HouseholdName": "Pinnacle Inc",
    "SourceSystem": "CSV",
    "SourceSystemReferenceValue": "CDRM_336627",
    "CreatedByModule": "HZ_WS",
    "Type": "ZCA_CUSTOMER",
    "PrimaryAddress": [
        {
            "AddressLine1": "500 Oracle Parkway",
            "City": "Redwood Shores",
            "State": "CA",
            "Country": "US"
        }
    ]
}
「トップに戻る」