機械翻訳について
  1. Oracle Fusion Cloud ProcurementのREST API
  2. タスク
  3. 公開ショッピング・リスト

すべてのヘッダーを取得

get

/fscmRestApi/resources/11.13.18.05/publicShoppingLists

リクエスト

問合せパラメータ
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 主キーに従って公開ショッピング・リスト・ヘッダーを検索します。
      ファインダ変数:
      • PublicShoppingListHeaderId; integer; 公開ショッピング・リストを一意に識別する値。
    • findByActivePublicShoppingList : すべてのアクティブな公開ショッピング・リスト・ヘッダーを検索します。
      ファインダ変数:
      • findByPSLAndProcBU : 公開ショッピング・リスト名に従って、公開ショッピング・リスト・ヘッダーを検索します。
        ファインダ変数:
        • ProcurementBU; string; 公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。
        • PublicShoppingList; string; 公開ショッピング・リストの名前。
        • SysEffectiveDate; object.
      • findByProcurementBU : 調達BUに従って、公開ショッピング・リスト・ヘッダーを検索します。
        ファインダ変数:
        • ProcurementBU; string; 公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。
        • SysEffectiveDate; object.
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

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

      フォーマット: ?q=expression1;expression2
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    レスポンス

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文 ()
    ルート・スキーマ : publicShoppingLists
    タイプ: object
    ソースを表示
    ネストされたスキーマ : 品目
    タイプ: array
    タイトル: Items
    コレクション内の品目。
    ソースを表示
    ネストされたスキーマ : publicShoppingLists-item-response
    タイプ: object
    ソースを表示
    トップに戻る

    例

    この例では、すべてのヘッダーを取得する方法について説明します。

    cURLコマンドの例

    次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

    curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingLists"

    たとえば:

    curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingLists/?finder=findByProcurementBU;ProcurementBU="Vision Services"&orderBy=CreationDate:desc"

    レスポンス本文の例

    JSON形式のレスポンス本文の例を次に示します。 
    {
    "items": [
        {
            "PublicShoppingListHeaderId": 300100559285633,
            "PublicShoppingList": "Pediatric Services",
            "ProcurementBUId": 458,
            "ProcurementBU": "Vision Services",
            "PublicShoppingListDescription": "Speech-Language Therapy, Occupational Therapy, Physical Therapy, Child Development Services.\n",
            "PublicShoppingListEndDate": null,
            "PublicShoppingListStartDate": "2022-07-20",
            "CreatedBy": "CVRQST17",
            "CreationDate": "2022-07-20T21:00:43+00:00",
            "LastUpdateDate": "2022-07-20T21:01:52.113+00:00",
            "LastUpdatedBy": "CVRQST17",
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559285633",
                    "name": "publicShoppingLists",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/publicShoppingLists/300100559285633",
                    "name": "publicShoppingLists",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/publicShoppingLists",
            "name": "publicShoppingLists",
            "kind": "collection"
        }
    ]
}
    「トップに戻る」