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

プライマリ住所の更新

patch

/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
  • 担当者パーティの代替キー識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
リクエスト本文 - 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
    作成中に内部的に生成された住所の代替キー識別子。 AddressNumberは、担当者の作成時に自動生成され、担当者の作成時にリクエスト・ペイロードに含める必要はありません。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 担当者の作成時に指定しなかった場合は、プロファイル・オプションZCA_PUID_PREFIXの受入れ済の値のリストを使用して自動的に生成され、内部で生成された一意の連番と連結されます。
  • タイトル: Building
    最大長: 240
    特定の住所の特定の建物名または番号。
  • タイトル: City
    最大長: 60
    プライマリ住所の市区町村要素。
  • タイトル: Comments
    最大長: 2000
    住所のユーザー・コメント。
  • デフォルト値: 0
    競合の一意の識別子。
  • 最大長: 15
    住所に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Country
    最大長: 2
    住所の国コード。 この属性は、FND_TERRITORY表のTERRITORY_CODE列で定義されます。
  • タイトル: County
    最大長: 60
    住所の郡要素。
  • 最大長: 30
    住所に関連付けられた通貨換算レート・タイプ。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    住所に関連付けられた通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • タイトル: Validated Date
    住所が最後に検証された日付。
  • タイトル: Delete Primary Address
    プライマリ住所が削除されたかどうかを示します。 値がTrueの場合、プライマリ住所は削除されます。 デフォルト値は「False」です。
  • タイトル: Description
    最大長: 2000
    住所の所在地の詳細な説明。
  • タイトル: Don't Validate
    最大長: 1
    DNCオプションを示す担当者プリファレンスを示します。
  • タイトル: 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の場合、住所はプライマリ住所です。
  • タイトル: Site Name
    最大長: 240
    パーティ・サイトの名前。
  • タイトル: One-Time Address
    最大長: 30
    パーティ・サイトのタイプ情報。
  • タイトル: Postal Code
    最大長: 60
    正式な国全体の郵便番号システムによって定義された郵便番号。
  • タイトル: Postal Code Extension
    最大長: 20
    アメリカ合衆国の郵便番号の4桁の拡張子。
  • タイトル: Province
    最大長: 60
    住所の州要素。
  • タイトル: Short Description
    最大長: 240
    サイト・レコードを説明する短い自由形式テキスト。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 SourceSystemの値は、参照タイプHZ_ORIG_SYSTEMS_VLで事前定義されている必要があります。 「設定およびメンテナンス」作業領域の取引先コミュニティ・ソース・システムの管理を使用して、この属性の値をレビューおよび更新します。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: State
    最大長: 60
    住所の州要素。
  • 最大長: 1
    デフォルト値: A
    レコードのステータス。
  • タイトル: Time Zone
    最大長: 64
    事業所のタイム・ゾーン。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証されたかどうかを示します。 値がTrueの場合、ロケーションが検証されます。 デフォルト値は「False」です。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : contacts-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およびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • タイトル: 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
    作成中に内部的に生成された住所の代替キー識別子。 AddressNumberは、担当者の作成時に自動生成され、担当者の作成時にリクエスト・ペイロードに含める必要はありません。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 担当者の作成時に指定しなかった場合は、プロファイル・オプションZCA_PUID_PREFIXの受入れ済の値のリストを使用して自動的に生成され、内部で生成された一意の連番と連結されます。
  • タイトル: Building
    最大長: 240
    特定の住所の特定の建物名または番号。
  • タイトル: City
    最大長: 60
    プライマリ住所の市区町村要素。
  • タイトル: Comments
    最大長: 2000
    住所のユーザー・コメント。
  • デフォルト値: 0
    競合の一意の識別子。
  • 最大長: 15
    住所に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Country
    最大長: 2
    住所の国コード。 この属性は、FND_TERRITORY表のTERRITORY_CODE列で定義されます。
  • タイトル: 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の場合、プライマリ住所は削除されます。 デフォルト値は「False」です。
  • タイトル: Description
    最大長: 2000
    住所の所在地の詳細な説明。
  • タイトル: Don't Validate
    最大長: 1
    DNCオプションを示す担当者プリファレンスを示します。
  • タイトル: 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
    サイト・レコードを説明する短い自由形式テキスト。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 SourceSystemの値は、参照タイプHZ_ORIG_SYSTEMS_VLで事前定義されている必要があります。 「設定およびメンテナンス」作業領域の取引先コミュニティ・ソース・システムの管理を使用して、この属性の値をレビューおよび更新します。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: From Date
    レコードが有効になる日付。
  • タイトル: State
    最大長: 60
    住所の州要素。
  • 最大長: 1
    デフォルト値: A
    レコードのステータス。
  • タイトル: Time Zone
    最大長: 64
    事業所のタイム・ゾーン。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証されたかどうかを示します。 値がTrueの場合、ロケーションが検証されます。 デフォルト値は「False」です。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
リンク
CountriesLOV
パラメータ:
  • ファインダ: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
テリトリ・リソースは、ISO標準テリトリのリストを取得するために使用されます。
HouseTypeLookupLOV
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによってプライマリ・アドレスを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CDRM_336942/child/PrimaryAddress/CDRM_100949

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "AddressLine1": "600 Oracle Parkway",
    "City": "Redwood Shores",
    "State": "CA",
    "Country": "US"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "AddressId": 300100046397212,
    "AddressNumber": "CDRM_100949",
    "AddressLine1": "600 Oracle Parkway",
    "City": "Redwood Shores ",
    "Country": "US",
    "State": "CA",
    "FormattedMultiLineAddress": "600 Oracle Parkway Redwood Shores, CA",
    ...
}
「トップに戻る」