機械翻訳について

住所の取得

get

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

リクエスト

パス・パラメータ
  • 作成中に内部的に生成された住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプション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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-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
    住所の一意の識別子。
  • タイトル: Address Lines Phonetic
    最大長: 560
    漢字の住所行の表記またはカナ。 これは日本の住所に使用されます。
  • Address Locales
    タイトル: Address Locales
    アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。
  • タイトル: Site Number
    最大長: 30
    作成中に内部的に生成された住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • Address Purposes
    タイトル: Address Purposes
    住所目的リソースは、住所目的の表示、作成、更新および削除に使用されます。 住所目的は、出荷先住所や請求先住所などの住所のタイプを記述します。
  • タイトル: Type
    住所のタイプ。
  • タイトル: Building
    最大長: 240
    住所の建物名または番号。
  • フォーマットされたアドレス。
  • タイトル: City
    最大長: 60
    住所の市区町村。
  • タイトル: CLLI Code
    最大長: 60
    住所の共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米内で使用されます。
  • タイトル: Comments
    最大長: 2000
    住所に対するユーザー指定のコメント。
  • デフォルト値: 0
    競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • タイトル: Corporate Currency
    最大長: 15
    アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Country
    最大長: 2
    住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
  • タイトル: County
    最大長: 60
    住所の郡。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    取引先レコードを作成したユーザー。
  • デフォルト値: HZ_WS
    住所レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
  • タイトル: Created by Application
    最大長: 30
    モジュールを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • タイトル: Currency Conversion Rate Type
    最大長: 30
    通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Code
    最大長: 15
    通貨コード。 有効な値のリストは、参照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
    住所に関連付けられたアカウントの一意の識別子。
  • タイトル: Party Number
    住所に関連付けられたアカウントの一意の代替識別子。 非アクティブなレコードは更新できません。
  • タイトル: Site Name
    最大長: 240
    住所のユーザー定義名。
  • タイトル: Party Source System
    住所に関連付けられたアカウント・パーティがインポートされる外部ソース・システムの名前。 値は、設定タスク取引先コミュニティ・ソース・システムで構成できます。
  • タイトル: Party Source System Reference Value
    属性PartySourceSystemで指定された外部ソース・システムからの、住所に関連付けられたアカウントの一意の識別子。
  • タイトル: Postal Code
    最大長: 60
    住所の郵便番号。
  • タイトル: Postal Code Extension
    最大長: 20
    住所の米国郵便番号への4桁の内線番号。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    これがアカウントのプライマリ住所かどうかを示します。 値がYの場合、この住所はアカウントのプライマリ住所です。 デフォルト値はNです。
  • タイトル: Province
    最大長: 60
    住所の州。
  • 住所のインポート元の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
  • 属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
  • 読取り専用: true
    最大長: 255
    レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
  • 読取り専用: true
    最大長: 255
    デフォルト値: HZ_PARTIES
    パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
  • タイトル: Start Date
    住所がアクティブになる日付。
  • タイトル: State
    最大長: 60
    住所の状態。
  • タイトル: Status
    最大長: 1
    デフォルト値: A
    住所のステータスを示す内部フラグ。 ステータス・コードは、参照HZ_STATUSによって定義されます。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証済かどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
  • 読取り専用: true
    検証がアクティブになる日付。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
ネストされたスキーマ : 住所ロケール
タイプ: array
タイトル: Address Locales
アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。
ソースを表示
ネストされたスキーマ : 住所目的
タイプ: array
タイトル: Address Purposes
住所目的リソースは、住所目的の表示、作成、更新および削除に使用されます。 住所目的は、出荷先住所や請求先住所などの住所のタイプを記述します。
ソースを表示
ネストされたスキーマ : accounts-Address-AddressLocale-item-response
タイプ: object
ソースを表示
  • タイトル: Address Element Attribute 1
    最大長: 150
    フレキシブル住所書式をローカル言語でサポートする追加住所要素1。
  • タイトル: Address Element Attribute 2
    最大長: 150
    フレキシブル住所書式をローカル言語でサポートする追加住所要素2。
  • タイトル: Address Element Attribute 3
    最大長: 150
    フレキシブル住所書式をローカル言語でサポートする追加住所要素3。
  • タイトル: Address Element Attribute 4
    最大長: 150
    フレキシブル住所書式をローカル言語でサポートする追加住所要素4。
  • タイトル: Address Element Attribute 5
    最大長: 150
    フレキシブル住所書式をローカル言語でサポートする追加住所要素5。
  • タイトル: Address Line 1
    最大長: 240
    ローカル言語での住所の1行目。
  • タイトル: Address Line 2
    最大長: 240
    ローカル言語での住所の2行目。
  • タイトル: Address Line 3
    最大長: 240
    ローカル言語での住所の3行目。
  • タイトル: Address Line 4
    最大長: 240
    ローカル言語での住所の4行目。
  • タイトル: Site Number
    読取り専用: true
    最大長: 30
    作成中に内部的に生成される一意の住所識別子。 次のキーのいずれかを使用して、更新時に住所目的レコードを識別: AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValue。
  • タイトル: Building
    最大長: 240
    ローカル言語での特定の住所の特定の建物名または番号。
  • タイトル: City
    最大長: 60
    市区町村の名前(現地言語)。
  • タイトル: Country
    読取り専用: true
    最大長: 2
    ローカル言語での国の特定の名前。
  • タイトル: County
    最大長: 60
    ローカル言語での郡の固有名。
  • 読取り専用: true
    最大長: 64
    住所ロケール・レコードを作成したユーザー。
  • 読取り専用: true
    住所ロケール・レコードが作成された日時。
  • タイトル: Floor
    最大長: 240
    建物番号がローカル言語で提供されている場合、特定の住所または特定の建物における特定の階数。
  • 読取り専用: true
    ロケール・アドレスの書式付き読取り専用バージョン。
  • 読取り専用: true
    住所ロケールが最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    住所ロケール・レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    住所ロケール・レコードを最後に更新したユーザーのログイン。
  • Links
  • 事業所レコードの一意の識別子。
  • 読取り専用: true
    事業所ロケール・レコードの一意の識別子。
  • タイトル: Postal Code
    最大長: 60
    ロケールの郵便番号。 郵便番号は、郵便番号、郵便番号、または郵便番号として様々な国で知られているもので、郵便を現地言語で並べ替える目的で、郵送先住所に追加される一連の文字または数字です。
  • タイトル: Postal Code Extension
    最大長: 20
    ローカルの言語でのアメリカ合衆国郵便番号の4桁の拡張。
  • タイトル: Province
    最大長: 60
    ローカル言語での都道府県名。
  • システム設定の一部として管理者が定義する、コードによって示される親住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの親住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: State
    最大長: 60
    ローカル言語での都道府県名。
  • タイトル: Transliteration Language
    最大長: 4
    翻訳言語は、外国語で単語や名前を発音するのに役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。 サンプル値はUS、NL、DKです。
ネストされたスキーマ : accounts-Address-AddressPurpose-item-response
タイプ: object
ソースを表示
  • 作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。
  • タイトル: Site Number
    読取り専用: true
    最大長: 30
    作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。
  • 読取り専用: true
    住所目的の一意の識別子。
  • タイトル: Comments
    最大長: 2000
    住所目的のユーザー・コメント。
  • 読取り専用: true
    最大長: 64
    住所目的レコードを作成したユーザー。
  • 最大長: 30
    デフォルト値: HZ_WS
    この住所目的レコードを作成したアプリケーション・モジュール。 CreatedByModuleのデフォルト値は、すべてのWebサービス・ベースの作成でHZ_WSです。 受け入れられる値のリストは、参照タイプHZ_CREATED_BY_MODULESで定義されます。 この属性の値は、設定およびメンテナンス・タスク作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
  • 読取り専用: true
    住所目的レコードが作成された日時。
  • 住所目的を削除するかどうかを示します。 値がYの場合、住所目的を削除する必要があります。 デフォルト値はNです。
  • タイトル: To Date
    住所目的が無効になった日付。
  • 読取り専用: true
    住所目的が最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    住所目的レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    住所目的レコードを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Primary
    最大長: 1
    デフォルト値: N
    これがサイトの主用途であるかどうかを示します。 Yはプライマリ・サイトを表し、Nは他のすべてのサイトを表します。
  • タイトル: Purpose
    最大長: 30
    住所の目的。 有効な値のリストは参照PARTY_SITE_USE_CODEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
  • システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • 外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • システム設定の一部として管理者が定義する、コードで示される住所目的の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、アドレスの目的を識別するための外部キーとして使用されます。
  • 外部ソースからの住所目的の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
  • タイトル: From Date
    住所目的が有効である開始日。
  • タイトル: Status
    最大長: 1
    デフォルト値: A
    関連付けられた住所レコードに対して住所目的がまだ有効かどうかを示します。 値Aはアクティブを示し、Iは非アクティブを示します。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、アドレスを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_296944/child/Address/CDRM_202152

レスポンス本文の例

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

{
   "PartyId" : 300100046354520,
   "PartyNumber" : "CDRM_296944",
   "AddressId" : 300100046354531,
   "AddressNumber" : "CDRM_202152",
   "CreatedByModule" : "HZ_WS",
   "FormattedAddress" : "REDWOOD SHORES, CA",
   "FormattedMultilineAddress" : "REDWOOD SHORES, CA",
   "City" : "Redwood Shores",
   "Country" : "US",
   "State" : "CA",
   ...  
}

「トップに戻る」