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

すべてのショッピング・リストの取得

get

/fscmRestApi/resources/11.13.18.05/shoppingLists

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • PrimaryKey主キーに従ってショッピング・リスト・ヘッダーを検索します。
      ファインダ変数
      • ShoppingListHeaderId; integer; ショッピング・リストを一意に識別する値。
      • ShoppingListType; string; ショッピング・リストのタイプを示す値。 有効な値は、PUBLICまたはPERSONALです。
    • findByRequisitioningBUAndShoppingList購買依頼発行BU IDおよびショッピング・リスト名に従って、ショッピング・リスト・ヘッダーを検索します。
      ファインダ変数
      • RequisitioningBUId; integer; 購買依頼発行BUを一意に識別する値。
      • ShoppingListName; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ShoppingList; string; ショッピング・リストの名前。
    • ShoppingListHeaderId; integer; ショッピング・リストを一意に識別する値。
    • ShoppingListType; string; ショッピング・リストのタイプを示す値。 有効な値は、PUBLICまたはPERSONALです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : shoppingLists
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : shoppingLists-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 64
    ショッピング・リストを作成したユーザー。
  • 読取り専用: true
    ユーザーがショッピング・リストを作成した日時。
  • 読取り専用: true
    最大長: 1000
    ショッピング・リストを表すイメージを特定するURL。
  • 読取り専用: true
    ユーザーがショッピング・リストを最後に更新した日時。
  • 読取り専用: true
    最大長: 64
    ショッピング・リストを最後に更新したユーザー。
  • Links
  • タイトル: Shopping List
    読取り専用: true
    最大長: 100
    ショッピング・リストの名前。
  • タイトル: Shopping List Description
    読取り専用: true
    最大長: 250
    ショッピング・リストの説明。
  • 読取り専用: true
    ショッピング・リストを一意に識別する値。
  • タイトル: Shopping List Type
    読取り専用: true
    最大長: 6
    ショッピング・リストのタイプを示す値です。 有効な値は、PUBLICまたはPERSONALです。
トップに戻る

例

この例では、すべてのショッピング・リストを取得する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを発行し、リクエスト元のBUで使用可能なすべてのショッピング・リストを取得します:

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

たとえば:

curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingLists? finder=findByRequisitioningBUAndShoppingList;RequisitioningBUId=204"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます: 
{
    "items": [
        {
            "ShoppingListHeaderId": 300100565393869,
            "ShoppingList": "Cardiology Department - Angioplasty & Stent Placement Surgery Supplies and Equipment",
            "ShoppingListDescription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
            "ShoppingListType": "PUBLIC",
            "ImageURL": null,
            "CreationDate": "2022-10-31T08:06:09.267+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdateDate": "2022-10-31T08:06:10.019+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1CD000000065055424C4943",
                    "name": "shoppingLists",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1CD000000065055424C4943",
                    "name": "shoppingLists",
                    "kind": "item"
                }
            ]
        },
        {
            "ShoppingListHeaderId": 300100565393865,
            "ShoppingList": "Cardiology Department - Medical and Surgical Gloves for Operating Room 7",
            "ShoppingListDescription": null,
            "ShoppingListType": "PUBLIC",
            "ImageURL": null,
            "CreationDate": "2022-10-31T08:06:09+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdatedBy": "CVBUYER01",
            "LastUpdateDate": "2022-10-31T08:06:09.997+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1C9000000065055424C4943",
                    "name": "shoppingLists",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1C9000000065055424C4943",
                    "name": "shoppingLists",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": true,
    "limit": 2,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/shoppingLists",
            "name": "shoppingLists",
            "kind": "collection"
        }
    ]
}
「トップに戻る」