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

すべての住所目的の取得

get

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

リクエスト

パス・パラメータ
  • 作成中に内部的に生成された住所の代替キー識別子。 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • AddressPurposeAltKey : 住所目的を持つ住所を検索します。
      ファインダ変数:
      • AddressId; integer; アドレスの一意の識別子。
      • 目的、文字列。アドレスの使用または目的を示します。
    • PrimaryKey : 住所主キーを持つ住所を検索します。
      ファインダ変数:
      • AddressPurposeId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AddressId; integer; 作成中に内部的に生成される一意のアドレス識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。
    • AddressNumber; string; 作成中に内部的に生成される一意のアドレス識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。
    • AddressPurposeId; integer; アドレス目的の一意の識別子。
    • コメント、文字列。アドレス目的に対するユーザー・コメント。
    • CreatedBy; string; アドレス目的レコードを作成したユーザー。
    • CreatedByModule; string; このアドレス目的レコードを作成したアプリケーション・モジュール。 CreatedByModuleのデフォルト値は、すべてのWebサービス・ベースの作成でHZ_WSです。 受け入れられる値のリストは、参照タイプHZ_CREATED_BY_MODULESで定義されます。 この属性の値は、設定およびメンテナンス・タスク作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。
    • CreationDate; string; アドレス目的レコードが作成された日時。
    • DeleteFlag; boolean;アドレス目的を削除するかどうかを示します。 値がYの場合、住所目的を削除する必要があります。 デフォルト値はNです。
    • EndDate; string; アドレス目的が無効になる日付。
    • LastUpdateDate; string; アドレスの目的が最後に更新された日時。
    • LastUpdateLogin; string; アドレス目的レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; アドレス目的レコードを最後に更新したユーザー。
    • PrimaryPerType; string; これがサイトの主用途であるかどうかを示します。 Yはプライマリ・サイトを表し、Nは他のすべてのサイトを表します。
    • 目的;文字列;アドレスの目的。 有効な値のリストは参照PARTY_SITE_USE_CODEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
    • StartDate; string; アドレスの目的が有効になる日付。
    • ステータス、文字列。住所目的が関連する住所レコードに対してまだ有効かどうかを示します。 値Aはアクティブを示し、Iは非アクティブを示します。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : accounts-Address-AddressPurpose
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : 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リソースに対する取得リクエストを発行することによって、すべてのアドレス目的を取得する方法を示しています。

レスポンス本文の例

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

{
  "PartyId" : 300100046354520,
  "PartyNumber" : "CDRM_336853",
   ...
{
  ... 
  "AddressId" : 300100046354531,
  "AddressNumber" : "CDRM_100059",
  ...
  {
    AddressPurposeId: 300100046374589
    Purpose: "BILL_TO"
    DeleteFlag: null
  }
}
}
「トップに戻る」