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

すべての住所の取得

get

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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>

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

    • 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;柔軟なアドレス形式をサポートするための追加のアドレス要素。
    • AddressId; integer; アドレスの一意の識別子。
    • AddressLineFour; string; addressの4行目。
    • AddressLineOne; string; アドレスの最初の行。
    • AddressLineThree; string; addressの3行目。
    • AddressLineTwo; string; addressの2行目。
    • AddressLinesPhonetic; string;漢字アドレス行の表記またはカナ。 これは日本の住所に使用されます。
    • AddressNumber; string; 作成中に内部的に生成されるアドレスの代替キー識別子。 AddressIdキーまたはAddressNumberキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
    • 建物;文字列;住所の建物名または番号。
    • City; string;住所の市区町村。
    • ClliCode; string;アドレスの共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米で使用されます。
    • コメント;文字列;ユーザーが入力したアドレスに対するコメント。
    • CorpCurrencyCode; string; 担当者に関連付けられた住所の企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCY.Reviewで定義され、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してプロファイル・オプションを更新します。
    • 国、文字列、住所の国。 地理の管理タスクを使用して国のリストをレビューします。
    • CountryName; string; パートナ会社の国名。
    • 郡;文字列;住所の郡。
    • CreatedBy; string; アドレス・レコードを作成したユーザー。
    • CreatedByModule; string; アドレス・レコードを作成したモジュール。
    • CreationDate; string;レコードが作成された日付。
    • CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyCode; string; 住所に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • DateValidated; string; アドレスが最後に検証された日付。
    • 説明;文字列;ロケーションの説明。
    • FloorNumber; string;アドレスの階数。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • 緯度;数値;住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。
    • LocationDirections; string; 住所の場所への方向。
    • LocationId; integer; 場所の一意の識別子。
    • 経度、数値、住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。
    • Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
    • PartyId; integer; 住所に関連付けられたパートナの一意の識別子。
    • PostalCode; string;住所の郵便番号。
    • PostalPlus4Code; string; 住所のアメリカ合衆国郵便番号の4桁の拡張子。
    • PrimaryFlag; boolean。これがパートナのプライマリ住所かどうかを示します。 値がYの場合、この住所はパートナのプライマリ住所です。 デフォルト値はNです。
    • 州;文字列;住所の都道府県。
    • State; string;アドレスの状態。
    • ValidatedFlag; boolean。ロケーションが検証されるかどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : partners-addresses
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : partners-addresses-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
    柔軟な住所書式をサポートするための追加の住所要素。
  • 読取り専用: true
    住所の一意の識別子。
  • タイトル: Address Line 4
    最大長: 240
    住所の4行目。
  • タイトル: Address Line 1
    最大長: 240
    住所の最初の行。
  • タイトル: Address Lines Phonetic
    最大長: 560
    漢字の住所行の表記またはカナ。 これは日本の住所に使用されます。
  • タイトル: Address Line 3
    最大長: 240
    住所の3行目。
  • タイトル: Address Line 2
    最大長: 240
    住所の2行目。
  • タイトル: Site Number
    最大長: 30
    作成中に内部的に生成された住所の代替キー識別子。 AddressIdキーまたはAddressNumberキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
  • タイトル: Type
    請求先住所、出荷先住所など、住所タイプの参照コード。
  • タイトル: Building
    最大長: 240
    住所の建物名または番号。
  • タイトル: City
    最大長: 60
    住所の市区町村。
  • タイトル: CLLI Code
    最大長: 60
    住所の共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米で使用されます。
  • タイトル: Comments
    最大長: 2000
    住所に対するユーザー指定のコメント。
  • 最大長: 15
    担当者に関連付けられた住所の企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCY.Reviewで定義され、「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用してプロファイル・オプションを更新します。
  • タイトル: Country
    最大長: 2
    住所の国。 地理の管理タスクを使用して国のリストをレビューします。
  • 読取り専用: true
    パートナ企業の国名。
  • タイトル: County
    最大長: 60
    住所の郡。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    住所レコードを作成したユーザー。
  • タイトル: Created by Application
    最大長: 30
    住所レコードを作成したモジュール。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日付。
  • 最大長: 30
    通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency
    最大長: 15
    住所に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Validated Date
    住所が最後に検証された日付。
  • タイトル: Description
    最大長: 2000
    事業所の摘要。
  • タイトル: Contact Preferences
    デフォルト値: false
    住所を郵送に使用しないかどうかを示します。
  • タイトル: Floor
    最大長: 40
    住所の階数。
  • タイトル: Address
    読取り専用: true
    住所の書式付きバージョン。
  • タイトル: Address
    読取り専用: true
    住所の書式付き複数行バージョン。
  • タイトル: 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
    住所に関連付けられたパートナの一意の識別子。
  • タイトル: Postal Code
    最大長: 60
    住所の郵便番号。
  • タイトル: Postal Code Extension
    最大長: 20
    住所の米国郵便番号への4桁の内線番号。
  • タイトル: Primary
    最大長: 1
    デフォルト値: false
    これがパートナのプライマリ住所かどうかを示します。 値がYの場合、この住所はパートナのプライマリ住所です。 デフォルト値はNです。
  • タイトル: Province
    最大長: 60
    住所の州。
  • 外部ソース・システムからのレコードの識別子。
  • 外部ソース・システムの名前。
  • タイトル: State
    最大長: 60
    住所の状態。
  • タイトル: Validated
    最大長: 1
    デフォルト値: false
    事業所が検証済かどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses

レスポンス本文の例

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

{
    "items": [
        {
            "PartyId": 300100546502851,
            "AddressId": 300100546502855,
            "AddressNumber": "CDRM_762038",
            "Comments": null,
            "DoNotMailFlag": false,
            "CorpCurrencyCode": "USD",
            "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "CreationDate": "2021-08-13T20:43:29.065+00:00",
            "CurcyConvRateType": "Corporate",
            "CurrencyCode": "USD",
            "LastUpdateDate": "2021-08-13T20:43:30.589+00:00",
            "LastUpdateLogin": "C96F4CD7A5095304E0533FFDF40AA82B",
            "LastUpdatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "LocationId": 300100546502854,
            "Mailstop": null,
            "PrimaryFlag": true,
            "AddressLinesPhonetic": null,
            "Building": null,
            "City": null,
            "ClliCode": null,
            "Country": "US",
            "County": null,
            "DateValidated": null,
            "Description": null,
            "FloorNumber": null,
            "Latitude": null,
            "LocationDirections": null,
            "Longitude": null,
            "PostalCode": null,
            "PostalPlus4Code": null,
            "Province": null,
            "State": null,
            "ValidatedFlag": false,
            "CountryName": "United States",
            "AddressType": null,
            "AddressLineOne": "2280 Quimby Road",
            "AddressLineTwo": null,
            "AddressLineThree": null,
            "AddressLineFour": null,
            "CreatedByModule": "USER_REGISTRATION",
            "FormattedAddress": "2280 Quimby Road",
            "FormattedMultilineAddress": "2280 Quimby Road",
            "AddrElementAttribute1": null,
            "AddrElementAttribute2": null,
            "AddrElementAttribute3": null,
            "AddrElementAttribute4": null,
            "AddrElementAttribute5": null,
            "SourceSystem": null,
            "SourceSystemReferenceValue": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/CDRM_45245/child/addresses/CDRM_762038",
                    "name": "addresses",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000002770400000002737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E00020000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/CDRM_45245/child/addresses/CDRM_762038",
                    "name": "addresses",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/CDRM_45245",
                    "name": "partners",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/CDRM_45245/child/addresses/CDRM_762038/lov/CountriesLOV",
                    "name": "CountriesLOV",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partners/CDRM_45245/child/addresses",
            "name": "addresses",
            "kind": "collection"
        }
    ]
}
「トップに戻る」