1つのスケジュールの取得
get
/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules/{purchaseOrderSchedulesUniqID}
リクエスト
パス・パラメータ
- purchaseOrderSchedulesUniqID(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のデフォルト・バージョンを選択します。
ルート・スキーマ : purchaseOrderSchedules-item-response
タイプ:
ソースを表示
object
-
AcceptedAmount: number
タイトル:
Accepted Amount
読取り専用:true
サービス明細に受け入れられた金額。 -
AcceptedQuantity: number
タイトル:
Accepted Quantity
読取り専用:true
検査後に検収された数量。 -
AccrueAtReceiptFlag: boolean
タイトル:
Accrue at Receipt
読取り専用:true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、受入時に購買オーダー・スケジュールを計上します。 falseの場合、受入時に計上しません。 -
Amount: number
タイトル:
Ordered
読取り専用:true
購買オーダー・スケジュールのサービスの金額。 -
AnticipatedArrivalDate: string (date)
タイトル:
Anticipated Arrival Date
読取り専用:true
現在の出荷予定日に基づいてオーダー済商品が搬送される予定日。 -
BilledAmount: number
タイトル:
Invoiced Amount
読取り専用:true
購買価格に基づいた照合済請求書明細に相当する金額。 -
BilledQuantity: number
タイトル:
Invoiced Quantity
読取り専用:true
購買オーダー・スケジュールに対して請求された数量。 -
Buyer: string
タイトル:
Buyer
読取り専用:true
最大長:240
購買オーダーの管理を担当する個人。 -
BuyerId: integer (int64)
読取り専用:
true
バイヤーを一意に識別する値。 -
Category: string
タイトル:
Category Name
読取り専用:true
最大長:2400
購買オーダーがオーダー明細の購買を分類するために使用する購買カテゴリの名前です。 -
CategoryCode: string
読取り専用:
true
最大長:820
購買カテゴリを識別する略称です。 -
CategoryId: integer (int64)
読取り専用:
true
購買カテゴリを一意に識別する値。 -
ClosedReason: string
タイトル:
Closed Reason
読取り専用:true
最大長:240
スケジュールがクローズされた理由を説明するテキスト。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
バイヤーまたはアプリケーションが購買オーダー・スケジュールを作成した日時。 -
DocumentStatus: string
タイトル:
Order Status
読取り専用:true
最大長:80
購買オーダー・ライフ・サイクルに対する購買オーダーのステータス。 -
DocumentStatusCode: string
タイトル:
Document Status Code
読取り専用:true
最大長:25
オーダー・ライフ・サイクルの購買オーダー・ステータスを識別する略称です。 -
DocumentStyle: string
タイトル:
Document Style
読取り専用:true
最大長:240
購買文書形式の名前。 この属性を使用すると、組織は、購買文書の使用と一致するように、アプリケーションに表示されるパラメータおよび値を制御できます。 -
DocumentStyleId: integer (int64)
読取り専用:
true
文書の購買形式を一意に識別する値。 -
FreightTerms: string
タイトル:
Freight Terms
読取り専用:true
最大長:80
品目を輸送するための手数料を支払う個人を説明する条件です。 -
FreightTermsCode: string
タイトル:
Freight Terms Code
読取り専用:true
最大長:30
購買オーダーの運送条件のタイプを識別する略称です。 -
FundsStatus: string
タイトル:
Funds Status
読取り専用:true
最大長:80
スケジュールの資金チェックまたは予算引当検証結果のステータス。 -
FundsStatusCode: string
タイトル:
Funds Status
読取り専用:true
最大長:25
資金ステータスを識別する略称です。 -
InvoiceMatchOption: string
タイトル:
Invoice Match Option
読取り専用:true
最大長:80
請求書を購買オーダーと照合するか受入と照合するかを決定する値。 購買オーダー明細が委託されている場合は、各請求書を消費通知と照合します。 -
InvoiceMatchOptionCode: string
タイトル:
Invoice Match Option Code
読取り専用:true
最大長:25
購買オーダー・スケジュールの請求書が、購買オーダーまたは受入と一致する必要があるかどうかを決定します。 値には、消費通知の場合はC、オーダーの場合はP、受入の場合はRがあります。 -
ItemDescription: string
タイトル:
Description
読取り専用:true
最大長:240
購買オーダーが参照する品目の摘要。 -
ItemId: integer (int64)
読取り専用:
true
購買オーダーの品目を一意に識別する値。 -
ItemNumber: string
タイトル:
Item
読取り専用:true
購買オーダーの品目を一意に識別する略称です。 -
LineLocationId: integer (int64)
読取り専用:
true
購買オーダー・スケジュールを一意に識別する値。 -
LineNumber: number
タイトル:
Line
読取り専用:true
購買オーダー明細を一意に識別する番号です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrderNumber: string
タイトル:
Order
読取り専用:true
最大長:30
販売先法的エンティティの購買オーダーを一意に識別する番号です。 -
PaymentTerms: string
タイトル:
Payment Terms
読取り専用:true
最大長:50
購買オーダーに対する各請求書の支払をスケジュールし、支払期日、割引日および割引金額を計算するためにアプリケーションで使用される条件。 -
PaymentTermsId: integer (int64)
読取り専用:
true
支払条件を一意に識別する値。 -
POHeaderId: integer (int64)
読取り専用:
true
購買オーダーを一意に識別する値。 -
POLineId: integer (int64)
読取り専用:
true
スケジュールの親明細を一意に識別する値。 この属性は、スケジュールが分割されるときに使用されます。 -
Price: number
タイトル:
Price
読取り専用:true
購買オーダー明細の価格です。 -
ProcurementBU: string
タイトル:
Procurement BU
読取り専用:true
最大長:240
購買オーダーを管理および所有するビジネス・ユニットです。 -
ProcurementBUId: integer (int64)
読取り専用:
true
購買オーダーを管理および所有するビジネス・ユニットを一意に識別する値。 -
PurchaseBasis: string
タイトル:
Purchase Basis
読取り専用:true
最大長:80
スケジュールが商品用かサービス用かを示す値。 -
PurchaseBasisCode: string
タイトル:
Purchase Basis Code
読取り専用:true
最大長:30
スケジュールが数量ベースの購買用か固定価格サービス用かを示す略称です。 -
Quantity: number
タイトル:
Quantity
読取り専用:true
出荷または搬送が予定されている品目の数量。 -
ReceivedAmount: number
タイトル:
Received Amount
読取り専用:true
サービス明細に対する受入済金額。 -
ReceivedQuantity: number
タイトル:
Received Quantity
読取り専用:true
購買オーダー・スケジュールに対する受入済数量です。 -
RequestedDeliveryDate: string (date)
タイトル:
Requested Delivery Date
読取り専用:true
サプライヤが品目を搬送するようにバイヤーがリクエストした日付。 -
RequestedShipDate: string (date)
タイトル:
Requested Ship Date
読取り専用:true
サプライヤが品目を出荷するようにバイヤーがリクエストした日付。 -
RequisitioningBU: string
タイトル:
Requisitioning BU
読取り専用:true
最大長:240
購買依頼を作成するビジネス・ユニットです。 -
RequisitioningBUId: integer (int64)
読取り専用:
true
購買依頼を作成するビジネス・ユニットを一意に識別する値。 -
RetainageAmount: number
タイトル:
Retainage
読取り専用:true
スケジュールに対する留保金として源泉徴収された合計金額。 -
RetainageRate: number
タイトル:
Retainage Rate
読取り専用:true
留保金として源泉徴収できる請求書値のパーセントです。 -
RetainageReleasedAmount: number
タイトル:
Retainage Released
読取り専用:true
スケジュールに対してリリースされた留保金額。 -
ScheduleDescription: string
タイトル:
Schedule Description
読取り専用:true
最大長:240
分割払いスケジュールに関連付けられた作業の摘要。 -
ScheduleNumber: integer
タイトル:
Schedule
読取り専用:true
購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。 -
ScheduleStatus: string
タイトル:
Status
読取り専用:true
最大長:80
購買オーダー・スケジュールのステータス。 -
ScheduleStatusCode: string
タイトル:
Status Code
読取り専用:true
最大長:25
購買オーダー・スケジュールのステータスを識別する略称です。 -
ScheduleType: string
タイトル:
Schedule Type
読取り専用:true
最大長:80
作業単位または総額のどちらに基づいて支払をリリースするかを識別する値。 -
ScheduleTypeCode: string
読取り専用:
true
最大長:30
スケジュール・タイプを識別する略称です。 -
ShippedAmount: number
タイトル:
Shipped Amount
読取り専用:true
サービス明細用に出荷された金額。 -
ShippedQuantity: number
タイトル:
Shipped Quantity
読取り専用:true
購買オーダー・スケジュールに対して出荷された数量。 -
ShipToCustomer: string
タイトル:
Ship-to Party
読取り専用:true
最大長:360
サプライヤが出荷する品目を受け入れるパーティの名前です。 -
ShipToCustomerId: integer (int64)
読取り専用:
true
品目を受け取る第三者を一意に識別する値です。 -
ShipToLocation: string
タイトル:
Ship-to Location
読取り専用:true
最大長:240
サプライヤが品目を出荷する事業所の名前です。 -
ShipToLocationCode: string
タイトル:
Ship-to Location Code
読取り専用:true
最大長:60
サプライヤが品目を出荷するロケーションを識別する略称です。 -
ShipToLocationId: integer (int64)
読取り専用:
true
サプライヤが品目を出荷する事業所を一意に識別する値です。 -
SoldToLegalEntity: string
タイトル:
Sold-to Legal Entity
読取り専用:true
最大長:240
購買オーダーの購買を財務的に担当する法的エンティティです。 -
SoldToLegalEntityId: integer (int64)
読取り専用:
true
購買オーダーの購買を財務的に担当する法的エンティティを一意に識別する値。 -
Supplier: string
タイトル:
Supplier
読取り専用:true
最大長:360
品目を履行するサプライヤの名前。 -
SupplierId: integer (int64)
読取り専用:
true
サプライヤを一意に識別する値。 -
SupplierItem: string
タイトル:
Supplier Item
読取り専用:true
最大長:300
サプライヤが購買オーダー明細の品目を識別するために使用する番号。 -
SupplierSite: string
タイトル:
Supplier Site
読取り専用:true
最大長:240
サプライヤが品目の購入に使用する事業所。 -
SupplierSiteId: integer (int64)
読取り専用:
true
サプライヤ・サイトを一意に識別する値。 -
Total: number
タイトル:
Total
読取り専用:true
購買オーダー明細のオーダー金額と外税金額の合計。 -
TotalTax: number
タイトル:
Total Tax
読取り専用:true
購入者が購買オーダー明細に対して控除および控除できない税抜金額の合計です。 -
UOM: string
タイトル:
UOM
読取り専用:true
最大長:25
品目数量の単位。 -
UOMCode: string
読取り専用:
true
最大長: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.
リンク
- 近い
-
パラメータ:
- purchaseOrderSchedulesUniqID:
$request.path.purchaseOrderSchedulesUniqID
購買オーダー・スケジュールをクローズします。 受入の消込、請求のクローズ、クローズまたはスケジュールのクローズを手動で実行できます。 - purchaseOrderSchedulesUniqID:
- confirmWork
-
パラメータ:
- purchaseOrderSchedulesUniqID:
$request.path.purchaseOrderSchedulesUniqID
分割払いスケジュールの既存の作業確認に明細を追加します。 パフォーマンス期間のスケジュールで完了した作業の数量、金額または割合を指定できます。 - purchaseOrderSchedulesUniqID:
例
この例では、1つのスケジュールを取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/purchaseOrderSchedulesUniqID"
たとえば、次のコマンドは、明細事業所識別子が300100185985737である購買オーダー・スケジュールを取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737"
例1 レスポンス本文
JSON形式のレスポンス本文の例を次に示します。
{ "POHeaderId": 300100185985423, "OrderNumber": "1011589", "ItemDescription": "test fps", "Price": null, "LineNumber": 2, "SupplierItem": null, "LineLocationId": 300100185985737, "ScheduleNumber": 1, "RequestedDeliveryDate": null, "ScheduleStatusCode": "CANCELED", "ClosedReason": null, "InvoiceMatchOptionCode": "P", "BilledQuantity": null, "ShippedQuantity": null, "ReceivedQuantity": null, "AcceptedQuantity": null, "BilledAmount": 0, "ShippedAmount": 0, "ReceivedAmount": 0, "AcceptedAmount": 0, "SoldToLegalEntity": "Vision Operations", "UOM": null, "ScheduleStatus": "Canceled", "Category": "Miscellaneous_1", "Buyer": "Furey,Clare", "InvoiceMatchOption": "Order", "PaymentTerms": "45 Net (terms date + 45)", "FreightTerms": "Due", "ShipToCustomer": null, "PurchaseBasisCode": "SERVICES", "ItemNumber": null, "Total": 0, "TotalTax": 0, "PurchaseBasis": "Services", "Quantity": null, "Amount": 0, "ShipToLocation": "V1- New York City", "DocumentStatus": "Canceled", "AnticipatedArrivalDate": null, "CreationDate": "2020-04-15T17:12:01+00:00", "RequestedShipDate": null, "Supplier": "CV_SuppA01", "SupplierSite": "CVSuppA01Site01", "RetainageRate": null, "RetainageAmount": null, "RetainageReleasedAmount": null, "ProcurementBU": "Vision Operations", "RequisitioningBU": "Vision Operations", "DocumentStyle": "Purchase Order", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737", "name": "purchaseOrderSchedules", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737", "name": "purchaseOrderSchedules", "kind": "item" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737/action/close", "name": "close", "kind": "other" } ] }
例2
この例では、fieldsパラメータを使用して追加の属性を問い合せる方法を示します。
例2 cURLコマンド
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453?fields=OrderNumber,ShipToLocationId,ShipToLocationCode,ShipToLocation,ItemId,CategoryId,SoldToLegalEntityId"
例2 レスポンス本文
JSON形式のレスポンス本文の例を次に示します。
{ "OrderNumber": "1000033", "ShipToLocationId": 211, "ShipToLocationCode": "VC - Vision City", "ShipToLocation": "VC - Vision City", "ItemId": null, "CategoryId": 2920, "SoldToLegalEntityId": 458, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453", "name": "purchaseOrderSchedules", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453", "name": "purchaseOrderSchedules", "kind": "item" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453/action/close", "name": "close", "kind": "other" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453/action/confirmWork", "name": "confirmWork", "kind": "other" } ] }