複数の個人ショッピング・リストの取得
get
/fscmRestApi/resources/11.13.18.05/personalShoppingLists
リクエスト
問合せパラメータ
- expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey:
ファインダ変数:- PersonalShoppingListHeaderId; integer; 個人ショッピング・リストを一意に識別する値。
- PrimaryKey:
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; ショッピング・リストを作成したユーザー。
- CreationDate; string; ショッピング・リストが作成された日時。
- ImageURL; string; 個人ショッピング・リストを表すイメージを特定するURL。
- LastUpdateDate; string; ショッピング・リストが最後に更新された日時。
- LastUpdatedBy; string; ショッピング・リストを最後に更新したユーザー。
- PersonalShoppingList; string; 個人ショッピング・リストを一意に識別する名前。
- PersonalShoppingListHeaderId; integer; 個人ショッピング・リストを一意に識別する値。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : personalShoppingLists
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : personalShoppingLists-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
ショッピング・リストを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ショッピング・リストが作成された日時。 -
ImageURL: string
最大長:
1000
個人ショッピング・リストを表すイメージを特定するURL。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ショッピング・リストが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
ショッピング・リストを最後に更新したユーザー。 -
lines: array Lines
タイトル:
Lines
明細リソースは、個人ショッピング・リストに追加された品目を管理します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PersonalShoppingList: string
タイトル:
Shopping List Name
最大長:80
個人ショッピング・リストを一意に識別する名前。 -
PersonalShoppingListHeaderId: integer (int64)
読取り専用:
true
個人ショッピング・リストを一意に識別する値。
ネストされたスキーマ : personalShoppingLists-lines-item-response
タイプ:
ソースを表示
object
-
Amount: number
購買会社の通貨でのショッピング・リスト明細品目の合計金額。
-
BPAPriceUserOverrideFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、個人ショッピング・リスト明細によって参照される包括購買契約価格属性がユーザーによって更新されました。 falseの場合、包括購買契約価格属性がユーザーによって更新されていません。 デフォルト値はfalseです。 この属性は現在使用されていません。 -
CategoryId: integer (int64)
ショッピング・リスト明細の購買カテゴリを一意に識別する値。
-
CategoryName: string
最大長:
2400
個人ショッピング・リスト明細の購買カテゴリを一意に識別する名前。 -
ConversionRate: number
購買依頼の通貨換算レートの決定に使用されるレートのタイプです。
-
ConversionRateDate: string (date)
換算レートを使用して金額を別の通貨に換算した日付。
-
ConversionRateType: string
最大長:
30
購買依頼の通貨換算レートの決定に使用されるレートのタイプです。 -
CreatedBy: string
読取り専用:
true
最大長:64
ショッピング・リスト明細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ショッピング・リスト明細が作成された日時。 -
Currency: string
タイトル:
Currency Name
最大長:80
ショッピング・リスト明細通貨の名前。 -
CurrencyCode: string
最大長:
15
ショッピング・リスト明細通貨を識別する略称です。 -
InventoryOrganization: string
タイトル:
Organization
最大長:240
個人ショッピング・リスト明細で使用されるマスター品目のソースである在庫組織の名前です。 -
InventoryOrganizationCode: string
最大長:
18
個人ショッピング・リスト明細のマスター品目のソースである在庫組織を一意に識別する略称です。 -
InventoryOrganizationId: integer (int64)
個人ショッピング・リスト明細のマスター品目に対するソースである在庫組織を一意に識別する値です。
-
Item: string
最大長:
300
ショッピング・リスト明細の品目を一意に識別する略称です。 -
ItemDescription: string
最大長:
240
ショッピング・リスト明細の商品またはサービスの摘要。 -
ItemId: integer (int64)
ショッピング・リスト明細の品目を一意に識別する値。
-
ItemRevision: string
最大長:
18
品目の改訂を識別する番号。 -
ItemSource: string
最大長:
25
-
LastUpdateDate: string (date-time)
読取り専用:
true
ショッピング・リスト明細が最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
ショッピング・リスト明細を最後に更新したユーザー。 -
LineImageURL: string
タイトル:
Image URL
読取り専用:true
個人ショッピング・リスト明細の商品またはサービスのイメージURLです。 -
LineType: string
タイトル:
Type
最大長:30
ショッピング・リスト明細が商品用かサービス用かを示すタイプを一意に識別する名前。 -
LineTypeId: integer (int64)
ショッピング・リスト明細が商品用かサービス用かを示すタイプを一意に識別する値。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManufacturerId: number
ショッピング・リスト明細の品目の製造業者を一意に識別する値。
-
ManufacturerName: string
最大長:
240
個人ショッピング・リスト明細の品目の製造業者を一意に識別する名前。 -
ManufacturerPartNumber: string
最大長:
700
製造業者が指定したとおりに品目を一意に識別する番号。 -
NegotiatedByPreparerFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ショッピング・リスト明細の品目の価格は、購買会社とサプライヤの間で事前に合意されます。 falseの場合、価格は事前に合意されません。 この属性にはデフォルト値がありません。 -
NegotiationRequiredFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買依頼明細を購買オーダーに配置する前に、見積のリクエストが必要です。 falseの場合、見積のリクエストは不要です。 この属性にはデフォルト値がありません。 -
NewSupplierFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ショッピング・リスト明細のサプライヤは新規サプライヤです。 falseの場合、ショッピング・リスト明細のサプライヤは既存のサプライヤです。 この属性にはデフォルト値がありません。 -
PersonalShoppingListHeaderId: integer (int64)
個人ショッピング・リストを一意に識別する値。
-
PersonalShoppingListLineId: integer (int64)
個人ショッピング・リスト明細を一意に識別する値。
-
PublicShoppingListHeaderId: integer (int64)
公開ショッピング・リストを一意に識別する値。
-
PunchoutCatalog: string
読取り専用:
true
最大長:30
ショッピング・リスト明細によって参照されるパンチアウト・カタログの名前。 -
PunchoutCatalogId: integer (int64)
ショッピング・リスト明細によって参照されるパンチアウト・カタログを一意に識別する値。
-
RequisitioningBU: string
タイトル:
Business Unit
最大長:240
ショッピング・リスト明細によって参照される購買依頼発行ビジネス・ユニットの名前。 -
RequisitioningBUId: integer (int64)
ショッピング・リスト明細によって参照される購買依頼発行ビジネス・ユニットを一意に識別する値です。
-
SmartFormId: integer (int64)
ショッピング・リスト明細によって参照されるスマート・フォームを一意に識別する値。
-
SmartFormName: string
最大長:
250
個人ショッピング・リスト明細によって参照されるスマート・フォームを一意に識別する名前。 -
SourceAgreement: string
タイトル:
Agreement
最大長:30
ショッピング・リスト明細によって参照されるソース契約を一意に識別する番号です。 -
SourceAgreementHeaderId: integer (int64)
ショッピング・リスト明細によって参照されるソース契約を一意に識別する値。
-
SourceAgreementLineId: integer (int64)
特定のソース契約のソース契約明細を一意に識別する値。
-
SourceAgreementLineNumber: number
タイトル:
Agreement Line
ショッピング・リスト明細によって参照されるソース契約の明細を識別する番号です。 -
SuggestedQuantity: number
個人ショッピング・リスト明細のデフォルト数量です。
-
SuggestedSupplier: string
最大長:
360
オーダー済商品およびサービスの履行のためにショッピング・リスト明細に提示された新規サプライヤの名前。 -
SuggestedSupplierContact: string
最大長:
80
顧客関係のサポートに関与する新規サプライヤを表す個人の名前。 -
SuggestedSupplierContactEmail: string
最大長:
1000
新規サプライヤを表す個人のEメール・アドレス。 -
SuggestedSupplierContactFax: string
最大長:
30
新規サプライヤを表す個人のFAX番号。 -
SuggestedSupplierContactPhone: string
最大長:
30
新規サプライヤを表す個人の電話番号。 -
SuggestedSupplierItemNumber: string
最大長:
300
提示サプライヤによって指定されたとおりに品目を一意に識別する番号。 -
SuggestedSupplierSite: string
最大長:
240
新規サプライヤを一意に識別する値。 -
Supplier: string
最大長:
360
ショッピング・リスト明細の商品またはサービスの履行でタスクされるサプライヤの名前。 -
SupplierContact: string
最大長:
4000
購買会社との通信に関するサプライヤを表す個人の名前。 -
SupplierContactEmail: string
読取り専用:
true
最大長:2000
サプライヤを表す個人のEメール・アドレス。 -
SupplierContactFax: string
読取り専用:
true
最大長:255
サプライヤを表す個人のFAX番号。 -
SupplierContactId: integer (int64)
サプライヤ担当を一意に識別する値。
-
SupplierContactPhone: string
読取り専用:
true
最大長:255
サプライヤを表す個人の電話番号。 -
SupplierId: integer (int64)
サプライヤを一意に識別する値。
-
SupplierSite: string
タイトル:
Supplier Site
最大長:240
ショッピング・リスト明細の商品またはサービスの購入元となるサプライヤ事業所の名前です。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを一意に識別する値。
-
UnitPrice: number
購買会社の通貨でのショッピング・リスト明細品目の価格。
-
UOM: string
タイトル:
UOM Name
最大長:25
品目数量の単位。 -
UOMCode: string
最大長:
3
単位を識別する略語。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.