1行取得
get
/fscmRestApi/resources/11.13.18.05/publicShoppingListLines/{publicShoppingListLinesUniqID}
リクエスト
パス・パラメータ
- publicShoppingListLinesUniqID(required): string
これは、公開ショッピング・リスト明細リソースの複合キーを構成し、公開ショッピング・リスト明細のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために、公開ショッピング・リスト明細の特定のインスタンスに移動するために、公開ショッピング・リスト明細コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - 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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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-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.
例
この例では、1行を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines/publicShoppingListLinesUniqID"
たとえば、次のコマンドは1行を取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614441"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"PublicShoppingListHeaderId": 300100187519046,
"PublicShoppingList": "MP_PSL02",
"PublicShoppingListDescription": "MP_PSL02 VO Desc",
"PublicShoppingListEndDate": null,
"PublicShoppingListStartDate": "2020-07-24",
"PublicShoppingListLineId": 300100197614441,
"Sequence": null,
"LineType": null,
"ItemId": 663907,
"Item": "RCV-100",
"ItemRevision": null,
"ItemDescription": "Plain Item",
"CategoryName": null,
"CategoryId": null,
"SuggestedQuantity": 9,
"UOM": null,
"Price": null,
"CurrencyCode": null,
"Amount": null,
"Supplier": null,
"SupplierItem": null,
"AgreementLineId": -2,
"Agreement": null,
"AgreementLine": null,
"Buyer": null,
"NegotiatedFlag": null,
"NegotiationRequiredFlag": null,
"CreatedBy": "CVRQST01",
"CreationDate": "2020-08-20T03:24:17+00:00",
"LastUpdateDate": "2020-08-20T03:24:17.251+00:00",
"LastUpdatedBy": "CVRQST01",
"InventoryOrganizationId": null,
"InventoryOrganization": null,
"IndexSyncPendingFlag": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614441",
"name": "publicShoppingListLines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/publicShoppingListLines/300100197614441",
"name": "publicShoppingListLines",
"kind": "item"
}
]
}