機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. ハブ組織
  4. 住所

住所の取得

get

/crmRestApi/resources/11.13.18.05/hubOrganizations/{PartyNumber}/child/Address/{AddressNumber}

リクエスト

パス・パラメータ
  • 住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
  • 組織パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : hubOrganizations-Address-item-response
タイプ: object
ソースを表示
  • タイトル: 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行目。
  • 読取り専用: true
    作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • タイトル: Address Lines Phonetic
    最大長: 560
    漢字住所行の表記(日本で使用)。
  • タイトル: Site Number
    最大長: 30
    住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
  • タイトル: Type
    住所のタイプ。
  • タイトル: Building
    最大長: 240
    特定の住所の特定の建物名または番号。
  • フォーマットされたアドレス。
  • タイトル: City
    最大長: 60
    住所の市区町村要素。
  • タイトル: CLLI Code
    最大長: 60
    共通言語事業所識別子(CLLI)コード。
  • タイトル: Comments
    最大長: 2000
    住所に対するユーザー・コメント。
  • デフォルト値: 0
    競合の一意の識別子。
  • タイトル: Corporate Currency
    最大長: 15
    住所に関連付けられた企業通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 この属性は、CRM拡張フレームワークで使用されます。
  • タイトル: Country
    最大長: 2
    住所の国コード。
  • タイトル: County
    最大長: 60
    住所の郡要素。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    住所レコードを作成したユーザー。
  • デフォルト値: HZ_WS
    この組織レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
  • タイトル: Created by Application
    最大長: 30
    この組織レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    住所に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    住所に関連する通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Validated Date
    住所が最後に検証された日付。
  • タイトル: Description
    最大長: 2000
    事業所の詳細な摘要。
  • タイトル: Contact Preferences
    デフォルト値: false
    この住所を郵送に使用しないことを示します。
  • タイトル: Don't Validate
    最大長: 1
    現在の検証ステータス・コードに関係なく、特定の事業所が住所検証に適格でないことを示します。
  • タイトル: D-U-N-S Number
    最大長: 30
    事業所のD-U-N-S番号。
  • 住所の有効日。
  • タイトル: End Date
    この住所が非アクティブにレンダリングされる日付。
  • タイトル: Floor
    最大長: 40
    建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
  • タイトル: Address
    読取り専用: true
    書式設定された住所情報。
  • タイトル: Formatted Address 1
    読取り専用: true
    書式設定された住所情報。
  • タイトル: 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
  • タイトル: Location Directions
    最大長: 640
    ロケーションへの道順。
  • タイトル: Location ID
    この住所の事業所レコードの一意の識別子。
  • タイトル: Longitude
    空間近接性および包含目的の事業所の経度情報を格納するために使用する属性。
  • タイトル: Mail Stop
    最大長: 60
    組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
  • オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • オプティミスティック・ロックの実装に使用される属性。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • タイトル: Party ID
    住所が関連付けられているアカウント、担当者または世帯の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
  • タイトル: Party Number
    住所が関連付けられているアカウント、担当者または世帯の代替の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値で、一意の生成された連番と連結されます。 値は、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに応じて更新できます。 有効な値のリストは、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通プロファイル・オプションの管理タスクを使用して、コードをレビューおよび更新します。 非アクティブなレコードは更新できません。
  • タイトル: Site Name
    最大長: 240
    住所のユーザー定義名。
  • タイトル: Party Source System
    住所が関連付けられている取引先、担当者または世帯の外部ソース・システムの名前。 取引先、担当者、または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
  • タイトル: Party Source System Reference Value
    住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子です。 代替キーの一部(PartySourceSystemとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
  • タイトル: Postal Code
    最大長: 60
    正式な国全体の郵便番号システムによって定義された郵便番号。
  • タイトル: Postal Code Extension
    最大長: 20
    アメリカ合衆国の郵便番号の4桁の拡張子。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    これが関連オブジェクトのプライマリ住所かどうかを示します。 プライマリ担当者の値Y、その他すべての場合はNを受け入れます。
  • タイトル: Province
    最大長: 60
    住所の州要素。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 読取り専用: true
    最大長: 255
    レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
  • 読取り専用: true
    最大長: 255
    デフォルト値: HZ_PARTIES
    パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
  • タイトル: Start Date
    この住所が有効である開始日。 作成時に指定されない場合は、現在のシステム日付にデフォルト設定されます。
  • タイトル: State
    最大長: 60
    住所の州要素。
  • タイトル: Status
    最大長: 1
    デフォルト値: A
    住所のステータスを示す内部アプリケーション決定フラグ。 ステータス・コードは、参照HZ_STATUSによって定義されます。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証されたかどうかを示します。 Y(検証済)、N(無効)。 値がTrueの場合、ロケーションが検証されます。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
  • 読取り専用: true
    検証が開始する日付。 内部的には、住所クレンジング中にシステムによって設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証の結果を説明する標準化されたステータス・コード。
リンク
CountriesLOV
パラメータ:
  • ファインダ: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
米国および英国など、住所の国を示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: 国、ターゲット属性: TerritoryCode
  • 表示属性: TerritoryShortName
FuseTypeLookupVA
パラメータ:
  • ファインダ: LookupTypeTagFinder%3BBindLookupType%3DPARTY_SITE_USE_CODE%2CBindTag%3DSALES_CLOUD
LOVリンク関連では、次のプロパティが定義されます:
  • ソース属性: AddressType;ターゲット属性: LookupCode
  • 表示属性: 意味
HouseTypeLookupLOV
パラメータ:
  • ファインダ: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE
ハウス・ボートやトレーラなど、住所のハウス・タイプを示す値リスト。

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