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

すべてのプライマリ住所の取得

get

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

リクエスト

パス・パラメータ
  • アカウント・パーティの一意の代替識別子。 プロファイル・オプション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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • PrimaryAddressNumberRF : 指定したパーティ・サイトを持つプライマリ住所を検索します。
      ファインダ変数:
      • AddressNumber;文字列;パーティ・サイト番号
    • PrimaryKey : 住所識別子を持つプライマリ住所の検索
      ファインダ変数:
      • AddressId;整数;一意のアドレス識別子
      • LocationLocationId; integer; 場所の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AddressElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressId; integer; プライマリ・アドレスの一意の識別子。
    • AddressLine1; string;プライマリ・アドレスの最初の行。
    • AddressLine2; string; プライマリ・アドレスの2行目。
    • AddressLine3; string; プライマリ・アドレスの3行目。
    • AddressLine4; string; プライマリ・アドレスの4行目。
    • AddressLinesPhonetic; string;漢字アドレス行の表記またはカナ。 これは日本の住所に使用されます。
    • AddressNumber; string; 作成中に内部的に生成されるプライマリ・アドレスの内部一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
    • 受取人;文字列;競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
    • 建物;文字列;プライマリ住所の建物名または番号。
    • City; string;プライマリ住所のcity要素。
    • コメント、文字列。プライマリ・アドレスに対するユーザー指定のコメント。
    • ConflictId; integer;競合の一意の識別子。
    • CorpCurrencyCode; string; アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • Country; string;プライマリ住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
    • County; string;プライマリ住所の郡。
    • CreatedBy; string;プライマリ住所レコードを作成したユーザー。
    • CreationDate; string;レコードが作成された日付。
    • CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string;通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DateValidated; string; プライマリ・アドレスが最後に検証された日付。
    • DeleteFlag; boolean;プライマリ・アドレスを削除するかどうかを示します。 値がYの場合、プライマリ住所を削除する必要があります。 デフォルト値はNです。
    • 説明;文字列;ロケーションの説明。
    • DoNotValidateFlag; boolean; DNCオプションを示す担当者プリファレンスを示します。
    • EndDateActive; string;アクティブ・ステータスのレコードの最終日。
    • FloorNumber; string;プライマリ・アドレスの階数。
    • HouseType; string;住所の建物の建物タイプを示します。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • 緯度;数値;住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。
    • LocationComments; string;フリー・テキスト形式のレコードの追加情報。
    • LocationDirections; string; 住所の場所への方向。
    • LocationId; integer; 場所の一意の識別子。
    • LocationIntegrationKey; string; 場所レコードの統合キー。
    • LocationLocationId; integer; 場所レコードのシステム識別子。
    • LocationSourceSystem; string; 場所レコードのソース・システムの名前。
    • LocationSourceSystemReferenceValue; string;外部ソース・システムからの関係の一意の識別子。
    • LocationStatusFlag; boolean;場所レコードのステータス・フラグ。
    • 経度、数値、住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。
    • Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
    • ObjectVersionNumberLocation; integer; ロケーション・オブジェクトの内部バージョン番号。 ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
    • ObjectVersionNumberPartySite; integer;パーティ・サイト・オブジェクトの内部バージョン番号。 ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
    • OverallPrimaryFlag; boolean;これが関連オブジェクトのプライマリ・アドレスかどうかを示します。 値がYの場合、住所はプライマリ住所です。
    • PartyId; integer; 住所に関連付けられたアカウントの一意の識別子。
    • PartySiteName; string;パーティ・サイトの名前。
    • PartySiteType; string;パーティ・サイトのタイプ情報。
    • PostalCode; string;住所の郵便番号。
    • PostalPlus4Code; string; 住所のアメリカ合衆国郵便番号の4桁の拡張子。
    • 州;文字列;住所の都道府県。
    • ShortDescription; string; サイト・レコードを説明する短いフリー・テキスト。
    • SourceSystem; string; アドレスがインポートされる外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
    • SourceSystemReferenceValue; string; 属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
    • StartDateActive; string; レコードがアクティブになる日付。
    • State; string;アドレスの状態。
    • ステータス、文字列、レコードのステータス。
    • TimezoneCode; string;ロケーションのタイムゾーン。
    • ValidatedFlag; boolean。ロケーションが検証されるかどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
    • 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-PrimaryAddress
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : accounts-PrimaryAddress-item-response
タイプ: object
ソースを表示
  • タイトル: Addressee
    最大長: 360
    競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • タイトル: 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
    プライマリ住所の一意の識別子。
  • タイトル: Address Line 1
    最大長: 240
    プライマリ住所の1行目。
  • タイトル: 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キーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • タイトル: Building
    最大長: 240
    プライマリ住所の建物名または番号。
  • タイトル: City
    最大長: 60
    プライマリ住所の市区町村要素。
  • タイトル: Comments
    最大長: 2000
    プライマリ住所のユーザー指定コメント。
  • デフォルト値: 0
    競合の一意の識別子。
  • 最大長: 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
    プライマリ住所を削除するかどうかを示します。 値がYの場合、プライマリ住所を削除する必要があります。 デフォルト値はNです。
  • タイトル: 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の場合、住所はプライマリ住所です。
  • 住所に関連付けられたアカウントの一意の識別子。
  • タイトル: Site Name
    最大長: 240
    パーティ・サイトの名前。
  • タイトル: One-Time Address
    最大長: 30
    パーティ・サイトのタイプ情報。
  • タイトル: Postal Code
    最大長: 60
    住所の郵便番号。
  • タイトル: Postal Code Extension
    最大長: 20
    住所の米国郵便番号への4桁の内線番号。
  • タイトル: Province
    最大長: 60
    住所の州。
  • タイトル: Short Description
    最大長: 240
    サイト・レコードを説明する短い自由形式テキスト。
  • 住所のインポート元の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
  • 属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
  • タイトル: From Date
    レコードが有効になる日付。
  • タイトル: State
    最大長: 60
    住所の状態。
  • 最大長: 1
    デフォルト値: A
    レコードのステータス。
  • タイトル: Time Zone
    最大長: 64
    事業所のタイム・ゾーン。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証済かどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
  • タイトル: Validation Status
    最大長: 30
    検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
トップに戻る

例:

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

cURLコマンド

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

レスポンス本文の例

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

{
  ... 
  "AddressId" : 1337,
  "AddressNumber" : "1337",
  LocationId: 1006
  PartyId: 1287
  ...
}
}
「トップに戻る」