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

すべての住所の取得

get

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

リクエスト

パス・パラメータ
  • 世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • AddressIdAltKey : 代替キーAddressIdでアドレスを検索します。
      ファインダ変数:
      • AddressId; integer; アドレスの一意の識別子。
    • AddressNumberAltKey : 住所を住所番号で検索します。
      ファインダ変数:
      • AddressNumber; string; アドレスの代替の一意の識別子。
    • AddressNumberRF : 住所の一意の識別子を持つ住所を検索します。
      ファインダ変数:
      • AddressNumber; string; アドレスの代替の一意の識別子。
    • PrimaryKey : 住所の主キー情報を含む住所を検索します。
      ファインダ変数:
      • AddressId; integer; アドレスの一意の識別子。
      • LocationId; integer;この場所の一意の識別子。
    • SourceSystemReferenceAltKey: 住所のソース・システム情報を含む住所を検索します。
      ファインダ変数:
      • SourceSystem; string;住所の外部ソース・システムの名前。
      • SourceSystemReferenceValue; string;外部ソース・システムからのこのアドレスの識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AddrElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddrElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddrElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddrElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddrElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • Address1; string; アドレスの最初の行。
    • Address2; string; addressの2行目。
    • Address3; string; addressの3行目。
    • Address4; string; addressの4行目。
    • AddressId; integer;作成中に内部的に生成される住所内部一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
    • AddressLinesPhonetic;文字列;漢字アドレス行の表記(日本で使用)。
    • AddressNumber; string; アドレスの代替の一意の識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
    • Building; string; 指定された住所の特定の建物名または番号。
    • City; string; addressのcity要素。
    • ClliCode; string;アドレスの共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米内で使用されます。
    • コメント;文字列;ユーザーが入力したアドレスに対するコメント。
    • ConflictId; integer; アドレス・レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
    • CorpCurrencyCode; string; 住所に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • Country; string;住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
    • County; string; 住所の郡要素。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreatedByModule1; string; レコードを作成したモジュール。
    • CreationDate; string; レコードが作成された日時。
    • CurcyConvRateType; string; 住所に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string; 住所に関連する通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DateValidated; string; アドレスが最後に検証された日付。
    • 説明;文字列;ロケーションの詳しい説明。
    • DoNotValidateFlag; boolean。現在の検証ステータス・コードに関係なく、特定のロケーションが住所検証に適格でないことを示します。
    • DunsNumberC; string;事業所のD-U-N-S番号。
    • EffectiveDate; string; アドレスがアクティブになる日付。
    • EndDateActive; string; このアドレスが非アクティブになる日付。
    • FloorNumber; string;特定の住所または建物番号が指定されている特定の建物の特定の階数。
    • HouseType; string;アドレス内の建物のタイプ。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • 緯度;数値;住所の緯度情報。 これは、空間近接性および包含目的で使用されます。
    • LocationDirections; string;場所への方向。
    • LocationId; integer;この場所の一意の識別子。
    • 経度、数値、住所の経度情報。 これは、空間近接性および包含目的で使用されます。
    • Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
    • ObjectVersionNumber; integer;オプティミスティック・ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • ObjectVersionNumber1; integer; アドレス・レコードに対するオプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • PartyId; integer; 住所が関連付けられているアカウント、担当者または世帯の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
    • PartyNumber; string; 住所が関連付けられているパーティ(アカウント、担当者または世帯)の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、作成時に属性値をシステム生成にするか、ユーザー指定にするかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
    • PartySiteName; string; アドレスのユーザー定義名。
    • PartySourceSystem; string; 住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。 取引先、担当者または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
    • PartySourceSystemReferenceValue; string; 住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの一意の識別子。 代替キーの一部(PartySourceSystemとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
    • PostalCode; string;正式な国全体の郵便番号システムで定義される郵便番号。
    • PostalPlus4Code; string;アメリカ合衆国郵便番号の4桁の拡張子。
    • PrimaryFlag; boolean;これが関連オブジェクトのプライマリ・アドレスかどうかを示します。 値がTrueの場合、これがプライマリ住所です。 デフォルト値は「False」です。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
    • 地方;文字列;住所の地方要素。
    • SSROwnerTableName; string; アドレス・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
    • SSRPartyOwnerTableName; string; パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
    • SourceSystem; string;システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
    • SourceSystemReferenceValue; string;外部ソースからのアドレスの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
    • StartDateActive; string; このアドレスがアクティブになる日付。 この値は、作成時に指定されていない場合、現在のシステム日付にデフォルト設定されます。
    • State; string; addressのstate要素。
    • ステータス;文字列;アドレスのステータスを示すアプリケーションによって決定される内部フラグ。 ステータス・コードは、参照HZ_STATUSによって定義されます。
    • ValidatedFlag; boolean。ロケーションが検証されたかどうかを示します。 値がTrueの場合、ロケーションが検証されます。 デフォルト値はfalseです。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
    • ValidationStatusCode; string; 検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : households-Address
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : households-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
    漢字住所行の表記(日本で使用)。
  • Address Locales
    タイトル: Address Locales
    アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。
  • タイトル: Site Number
    最大長: 30
    住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
  • 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
    住所を郵送に使用しないかどうかを示します。 値がYの場合、住所は担当者に郵送するために使用しないでください。 デフォルト値はNです。 住所の作成時にこの属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
  • タイトル: 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キーのいずれかが必要です。 プロファイル・オプション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
    これが関連オブジェクトのプライマリ住所かどうかを示します。 値がTrueの場合、これがプライマリ住所です。 デフォルト値は「False」です。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
  • タイトル: 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
    事業所が検証されたかどうかを示します。 値がTrueの場合、ロケーションが検証されます。 デフォルト値はfalseです。 この値は、住所クレンジング中にシステムによって内部的に設定されます。
  • 読取り専用: true
    検証が開始する日付。 この属性は、住所クレンジング中にシステムによって内部的に設定されます。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
ネストされたスキーマ : 住所ロケール
タイプ: array
タイトル: Address Locales
アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。
ソースを表示
ネストされたスキーマ : 住所目的
タイプ: array
タイトル: Address Purposes
住所目的リソースは、住所目的の表示、作成、更新および削除に使用されます。 住所目的は、出荷先住所や請求先住所などの住所のタイプを記述します。
ソースを表示
ネストされたスキーマ : households-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です。
ネストされたスキーマ : households-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
    住所目的レコードが作成された日時。
  • 住所目的を削除するかどうかを示します。 値がTrueの場合は、住所目的が削除されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
  • タイトル: 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コマンド

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

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

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "PartyId": 300100039356037,
    "PartyNumber": "CDRM_61285",
    "SourceSystem": null,
    "SourceSystemReferenceValue": null,
    "OrganizationName": "Pinnacle Flowers",
    "UniqueNameSuffix": "(Redwood Shores, US)",
    "PartyUniqueName": "Pinnacle Flowers (Redwood Shores, US)",
    "Type": "ZCA_CUSTOMER",
    "OwnerPartyId": 100010025532672,
    "OwnerPartyNumber": "100010025532672",
    "OwnerEmailAddress": "Tenng.lean@oracle.com",
    "PhoneCountryCode": null,
    "PhoneAreaCode": null,
    "PhoneNumber": null,
    "PhoneExtension": null,
    "FaxCountryCode": null,
    "FaxAreaCode": null,
    "FaxNumber": null,
    "PartyStatus": "A",
    "CreatedByModule": "HZ_WS",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdatedBy": "SALES_ADMIN",
    ...
	}
「トップに戻る」