すべての行を取得
get
/fscmRestApi/resources/11.13.18.05/publicShoppingListLines
リクエスト
問合せパラメータ
- effectiveDate: string
この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
- 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 : 主キーに従って公開ショッピング・リスト明細を検索します。
ファインダ変数:- PublicShoppingListLineId; integer; 公開ショッピング・リスト明細を一意に識別する値。
- findByAgreement : 契約に従って公開ショッピング・リスト明細を検索します。
ファインダ変数:- Agreement; string; 公開ショッピング・リスト明細で参照されるソース契約を識別する番号。
- AgreementLine; integer; 公開ショッピング・リスト明細によって参照されるソース契約の明細を識別する番号。
- findByItem : 品目に従って公開ショッピング・リスト明細を検索します。
ファインダ変数:- InventoryOrganization; string; インベントリ組織の名前。
- Item; string; 品目の名前。
- findByPublicShoppingList : 公開ショッピング・リストに従って、公開ショッピング・リスト明細を検索します。
ファインダ変数:- ProcurementBU; string; 公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。
- PublicShoppingList; string; 公開ショッピング・リストの名前。
- 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 - totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、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の値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : publicShoppingListLines
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : publicShoppingListLines-item-response
タイプ:
ソースを表示
object
-
Agreement: string
タイトル:
Agreement
公開ショッピング・リスト明細によって参照されるソース契約を識別する番号です。 -
AgreementLine: number
タイトル:
Agreement Line
公開ショッピング・リスト明細によって参照されるソース契約の明細を識別する番号です。 -
AgreementLineId: integer (int64)
タイトル:
Agreement Line ID
公開ショッピング・リスト明細によって参照されるソース契約の明細を一意に識別する値。 -
Amount: number
読取り専用:
true
ショッピング・リスト明細の合計金額。 -
Buyer: string
タイトル:
Buyer
読取り専用:true
最大長:240
参照契約のバイヤー名。 -
CategoryId: string
読取り専用:
true
最大長:255
購買カテゴリを一意に識別する値。 -
CategoryName: string
タイトル:
Category Name
読取り専用:true
最大長:255
作成される購買の分類に使用される購買カテゴリの名前です。 -
CreatedBy: string
読取り専用:
true
最大長:64
公開ショッピング・リスト明細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが公開ショッピング・リスト明細を作成した日時。 -
CurrencyCode: string
読取り専用:
true
最大長:255
ショッピング・リスト明細通貨を識別する略称です。 -
IndexSyncPendingFlag: boolean
タイトル:
Synchronization Pending
読取り専用:true
次のいずれかの値が含まれます: YまたはN。 Yの場合、更新はショッピング用に公開できます。 Nの場合、更新はショッピング用に公開できません。 デフォルト値はNです。 -
InventoryOrganization: string
読取り専用:
true
最大長:255
品目が定義されている組織の名前です。 -
InventoryOrganizationId: integer
読取り専用:
true
品目が定義されている組織を一意に識別する値。 -
Item: string
公開ショッピング・リスト明細の品目の名前。
-
ItemDescription: string
タイトル:
Description
読取り専用:true
最大長:240
品目の摘要。 -
ItemId: integer (int64)
品目を一意に識別する値。
-
ItemRevision: string
タイトル:
Revision
読取り専用:true
最大長:18
品目の改訂です。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが公開ショッピング・リスト明細を最後に更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
公開ショッピング・リスト明細を最後に更新したユーザー。 -
LineType: string
タイトル:
Line Type
読取り専用:true
最大長:30
明細が商品またはサービスのいずれであるかを示す値です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NegotiatedFlag: boolean
タイトル:
Negotiated
読取り専用:true
最大長:1
次のいずれかの値が含まれます: YまたはN。 Yの場合、公開ショッピング・ラインの価格は、購買会社とサプライヤとの間で事前に合意されます。 Nの場合、価格は事前に合意されません。 この属性にはデフォルト値がありません。 -
NegotiationRequiredFlag: boolean
タイトル:
Negotiation Required
読取り専用:true
最大長:1
次のいずれかの値が含まれます: YまたはN。 Yの場合は、ソーシング・ネゴシエーションが必要です。 Nの場合、ソーシング・ネゴシエーションは不要です。 この属性にはデフォルト値がありません。 -
Price: number
読取り専用:
true
品目の価格。 -
ProcurementBU: string
タイトル:
Procurement BU
公開ショッピング・リストが作成される調達ビジネス・ユニットの名前。 -
ProcurementBUId: integer
公開ショッピング・リストが作成される調達ビジネス・ユニットを一意に識別する値。
-
PublicShoppingList: string
公開ショッピング・リストの名前。
-
PublicShoppingListDescription: string
読取り専用:
true
最大長:250
公開ショッピング・リストの説明。 -
PublicShoppingListEndDate: string (date)
読取り専用:
true
公開ショッピング・リストが非アクティブ化される日時。 -
PublicShoppingListHeaderId: integer (int64)
公開ショッピング・リストを一意に識別する値。
-
PublicShoppingListLineId: integer (int64)
読取り専用:
true
公開ショッピング・リスト明細を一意に識別する値。 -
PublicShoppingListStartDate: string (date)
読取り専用:
true
公開ショッピング・リストがアクティブ化される日時。 -
Sequence: number
品目を作成者または依頼者に表示する順序。
-
SuggestedQuantity: number
カタログ管理者が作成者または依頼者に提示した数量です。
-
Supplier: string
タイトル:
Supplier
読取り専用:true
最大長:360
参照契約のサプライヤの名前。 -
SupplierItem: string
タイトル:
Supplier Item
読取り専用:true
最大長:300
契約から追加された商品またはサービスのサプライヤまたはコードを識別する値です。 -
UOM: string
読取り専用:
true
最大長:255
品目数量の単位。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、すべての行を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines"
たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines?finder=findByAgreement;Agreement='1000537'"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100003481973, "PublicShoppingList": "PORFUS_PuL1", "PublicShoppingListDescription": "PORFUS_PuL1", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2011-12-01", "PublicShoppingListLineId": 300100003481988, "Sequence": null, "LineType": "Goods", "ItemId": 100000013574113, "Item": "zPOR-SCH005_Dell_Inspiron_1525", "ItemRevision": null, "ItemDescription": "PORSCH00501 BPA2 Inspiron 1525 Laptop", "CategoryName": "Electrical Equipment_32", "CategoryId": "32", "SuggestedQuantity": 1, "UOM": "Each", "Price": 1000, "CurrencyCode": "USD", "Amount": 1000, "Supplier": "CV_SuppA00", "SupplierItem": "PORSCH00501 BPA2 SI", "AgreementLineId": 300100003264772, "Agreement": "1000537", "AgreementLine": 1, "Buyer": "Mancia,Mathew", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST05", "CreationDate": "2011-12-01T18:15:47.251+00:00", "LastUpdateDate": "2011-12-01T18:17:41.882+00:00", "LastUpdatedBy": "CVRQST05", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481988", "name": "publicShoppingListLines", "kind": "item" } ] }, { "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "PublicShoppingListHeaderId": 300100003481973, "PublicShoppingList": "PORFUS_PuL1", "PublicShoppingListDescription": "PORFUS_PuL1", "PublicShoppingListEndDate": null, "PublicShoppingListStartDate": "2011-12-01", "PublicShoppingListLineId": 300100003481987, "Sequence": null, "LineType": "Goods", "ItemId": -2, "Item": null, "ItemRevision": null, "ItemDescription": "PORSCH00501 BPA2 USB Drive One Time Item", "CategoryName": "Electrical Equipment_32", "CategoryId": "32", "SuggestedQuantity": 2, "UOM": "Each", "Price": 25, "CurrencyCode": "USD", "Amount": 50, "Supplier": "CV_SuppA00", "SupplierItem": "PORSCH005 BPA2 Item #3 SP", "AgreementLineId": 300100003264897, "Agreement": "1000537", "AgreementLine": 3, "Buyer": "Mancia,Mathew", "NegotiatedFlag": true, "NegotiationRequiredFlag": null, "CreatedBy": "CVRQST05", "CreationDate": "2011-12-01T18:15:47+00:00", "LastUpdateDate": "2011-12-01T18:17:41.872+00:00", "LastUpdatedBy": "CVRQST05", "InventoryOrganizationId": 204, "InventoryOrganization": "Vision Operations", "IndexSyncPendingFlag": false, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987", "name": "publicShoppingListLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100003481987", "name": "publicShoppingListLines", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines", "name": "publicShoppingListLines", "kind": "collection" } ] }