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

住所形式の書式の取得

get

/crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}

リクエスト

パス・パラメータ
  • 住所形式の書式の国コード。 この値はユーザーが追加することも、空白のままにすることもできます。 手動で追加した場合、国コードの住所形式書式が返されます。空白のままにした場合、使用可能な住所形式書式のリスト全体が返されます。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : addressStyleFormats-item-response
タイプ: object
ソースを表示
  • Address Style Format Layouts
    タイトル: Address Style Format Layouts
    住所形式の書式レイアウト・リソースは、住所書式のレイアウトを表示するために使用されます。 住所書式レイアウトは、住所のコンポーネントとレイアウトでのその位置を使用して決定されます。
  • 読取り専用: true
    最大長: 2
    住所形式の書式の国コード。 この値はユーザーが追加することも、空白のままにすることもできます。 手動で追加した場合、国コードの住所形式書式が返されます。空白のままにした場合、使用可能な住所形式書式のリスト全体が返されます。
  • 読取り専用: true
    最大長: 80
    住所形式の書式の国名です。
  • Links
  • 読取り専用: true
    最大長: 30
    住所形式の書式の形式書式コード。 この値が定義されていない場合は、デフォルトの郵便番号形式書式コードが返されます。 たとえば、USの場合、デフォルトのスタイル書式コードはPOSTAL_ADDR_USです。
  • 読取り専用: true
    最大長: 240
    住所形式の書式の書式の書式フォント名。
ネストされたスキーマ : 住所形式の書式レイアウト
タイプ: array
タイトル: Address Style Format Layouts
住所形式の書式レイアウト・リソースは、住所書式のレイアウトを表示するために使用されます。 住所書式レイアウトは、住所のコンポーネントとレイアウトでのその位置を使用して決定されます。
ソースを表示
ネストされたスキーマ : addressStyleFormats-AddressStyleFormatLayout-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 80
    住所書式レイアウトの住所フィールド・ラベルまたはプロンプト。
  • 読取り専用: true
    最大長: 120
    住所書式レイアウトの住所フィールド名。
  • 読取り専用: true
    最大長: 20
    属性がnullでない場合に属性の後ろに配置される1つ以上の文字を示します。
  • 読取り専用: true
    最大長: 20
    属性がnullでない場合に属性の前に配置される1つ以上の文字を示します。
  • 読取り専用: true
    住所書式レイアウトの住所フィールドの地理レベル。
  • 読取り専用: true
    最大長: 30
    住所書式レイアウトの住所フィールドの地理タイプ。 未定義の場合、値はNULLです。
  • 読取り専用: true
    属性を書式設定する行。
  • Links
  • 読取り専用: true
    最大長: 1
    属性がレイアウトに必須かどうかを示します。 この値は住所フォーマットに基づいています。
  • 読取り専用: true
    属性を配置する行の位置。
  • 読取り専用: true
    最大長: 1
    属性を大文字に変換する必要があるかどうかを示します。
リンク
AddressStyleFormatLayout
パラメータ:
  • CountryCode: $request.path.CountryCode
住所形式の書式レイアウト・リソースは、住所書式のレイアウトを表示するために使用されます。 住所書式レイアウトは、住所のコンポーネントとレイアウトでのその位置を使用して決定されます。
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/addressStyleFormats/AF

レスポンス本文の例

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

{
            "CountryCode": "AF",
            "CountryName": "Afghanistan",
            "StyleFormatCode": "POSTAL_ADDR_DEF",
            "StyleFormatName": "Default Postal Address Format",
            "links": [
                ...
            ]
       }
「トップに戻る」