機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. サプライヤ登録住所形式書式

すべての住所形式書式の取得

get

/fscmRestApi/resources/11.13.18.05/supplierRegistrationAddressStyleFormats

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey: 指定された識別子を持つサプライヤ登録住所形式を検索します。
      ファインダ変数:
      • CountryCode; string; 国の一意のコード識別子。
    • StyleFormatFilter: 指定した形式コードおよび国コードを持つサプライヤ登録住所形式を検索します。
      ファインダ変数:
      • BindCountryCode; string; サプライヤ登録住所形式書式の国コード。
      • BindStyleCode; string.
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

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

    次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CountryCode; string; 住所形式の書式の国コード。 この値は、ユーザーが追加することも、空白のままにすることもできます。 手動で追加すると、国コードの住所形式の書式が返され、空白のままにすると、使用可能な住所形式の書式のリスト全体が返されます。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : supplierRegistrationAddressStyleFormats
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : supplierRegistrationAddressStyleFormats-item-response
タイプ: object
ソースを表示
  • Address Style Format Layouts
    タイトル: Address Style Format Layouts
    Address Style Format Layoutリソースを使用して、住所書式のレイアウトを表示します。 住所書式レイアウトは、住所内のコンポーネントと、レイアウト内でのそれらの位置を使用して決定されます。
  • 読取り専用: true
    最大長: 2
    住所書式の国コード。 この値は、ユーザーが追加することも、空白のままにすることもできます。 手動で追加すると、国コードの住所形式の書式が返され、空白のままにすると、使用可能な住所形式の書式のリスト全体が返されます。
  • 読取り専用: true
    最大長: 80
    住所形式の書式の国名。
  • Links
  • 読取り専用: true
    最大長: 30
    住所形式書式の形式書式コード。 この値が定義されていない場合は、デフォルトの郵便番号形式コードが返されます。 たとえば、USの場合、デフォルトのスタイル・フォーマット・コードはPOSTAL_ADDR_USです。
  • 読取り専用: true
    最大長: 240
    住所形式の書式の書式名。
ネストされたスキーマ : 住所形式書式レイアウト
タイプ: array
タイトル: Address Style Format Layouts
Address Style Format Layoutリソースを使用して、住所書式のレイアウトを表示します。 住所書式レイアウトは、住所内のコンポーネントと、レイアウト内でのそれらの位置を使用して決定されます。
ソースを表示
ネストされたスキーマ : supplierRegistrationAddressStyleFormats-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
    英語翻訳で属性を大文字に変換するかどうかを示します。
「トップに戻る」