一括置換によって影響を受けるすべての購買オーダーを取得
get
/fscmRestApi/resources/11.13.18.05/summaryOfMassReplacementPurchaseOrders
リクエスト
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey一括置換の影響を受ける購買オーダーの要約を主キーに従って検索します。
ファインダ変数- PODetailId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ChangeOrderStatus; string; 一括置換中に購買オーダーに作成された変更オーダーのステータス。
- ChangeOrderStatusCode; string; 一括置換中に購買オーダーに作成された変更オーダーのステータス・コード。
- ExceptionFlag; boolean; 購買オーダー詳細の一括置換プロセスの実行中に例外が発生したことを示す属性。
- InlineReplacementFlag; boolean; 一括置換の対象となる購買オーダー詳細に対して置換処理が実行されるかどうかを示す属性。
- OriginalCurrencyCode; string; 一括置換の対象となる元の購買オーダーの通貨コード。
- OriginalPO; string; 一括置換の対象となる元の購買オーダー番号、明細番号、スケジュール番号および配分番号の連結値。
- OriginalPODistributionId; integer; 一括置換の対象となる元の購買オーダー配分を一意に識別する値。
- OriginalPOHeaderId; integer; 一括置換の対象となる元のPOヘッダーを一意に識別する値。
- OriginalPOLineId; integer; 一括置換の対象となる元の購買オーダー明細を一意に識別する値。
- OriginalPOLineLocationId; integer; 一括置換の対象となる元の購買オーダー・スケジュールを一意に識別する値。
- OriginalPrecision; integer; 元の購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値。
- OriginalPurchasingUOM; string; 一括置換の対象となる元の購買オーダー明細の購買単位の名前。
- OriginalPurchasingUOMCode; string; 一括置換の対象となる元の購買オーダー明細の購買単位コード。
- OriginalSPN; string; 一括置換の対象となる元の購買オーダー明細の仕入先部品番号。
- OriginalUnitPrice; number; 一括置換の対象となる元の購買オーダー明細の単価。
- PODetailId; integer; 置換アクションが実行されるPO詳細を一意に識別する値。
- POStatus; string; 一括置換の対象となる購買オーダー配分の置換ステータス。
- Phase; string; 購買オーダー配分で置換処理または再稼働処理の一括更新が行われるかどうかを示す属性。
- QuantityDue; number; 一括置換の対象となる元の購買オーダー配分のオーダー数量。
- ReplacementAction; string; 一括置換の対象となる購買オーダー配分に対して実行される置換処理のタイプ。
- ReplacementActionCode; string; 一括置換の対象となる購買オーダー配分に対して実行された置換処理のコード。
- ReplacementCurrencyCode; string; 一括置換プロセスによって作成された置換購買オーダーの通貨コード。
- ReplacementDetailId; integer; 置換タスクに対して作成された置換詳細を一意に識別する値。
- ReplacementId; integer; 置換タスクを一意に識別する値。
- ReplacementNumber; integer; 置換タスクの数。
- ReplacementPO; string; 一括置換プロセスによって作成された置換購買オーダー番号、明細番号、スケジュール番号および配分番号の連結値。
- ReplacementPODistributionId; integer; 一括置換プロセスによって作成された置換購買オーダー配分を一意に識別する値。
- ReplacementPOHeaderId; integer; 一括置換プロセスによって作成された置換購買オーダー・ヘッダーを一意に識別する値。
- ReplacementPOLineId; integer; 一括置換プロセスによって作成された置換購買オーダー明細を一意に識別する値。
- ReplacementPOLineLocationId; integer; 一括置換プロセスによって作成された置換購買オーダー・スケジュールを一意に識別する値。
- ReplacementPrecision; integer; 置換購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値。
- ReplacementPurchasingUOM; string; 一括置換プロセスによって導出された置換購買オーダー明細の購買単位の名前。
- ReplacementPurchasingUOMCode; string; 一括置換プロセスによって導出された置換購買オーダー明細の購買単位コード。
- ReplacementQuantityOrdered; number; 大量置換プロセスで導出された置換購買オーダー配分のオーダー数量。
- ReplacementSPN; string; 一括置換プロセスによって導出された置換購買オーダー明細の仕入先部品番号。
- ReplacementUnitPrice; number; 一括置換プロセスによって導出された置換購買オーダー明細の単価。
- ShipToOrganizationCode; string; 一括置換対象の購買オーダー・スケジュールが属する在庫組織のコード。
- ShipToOrganizationId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : summaryOfMassReplacementPurchaseOrders
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : summaryOfMassReplacementPurchaseOrders-item-response
タイプ:
ソースを表示
object
-
ChangeOrderStatus: string
読取り専用:
true
最大長:80
一括置換中に購買オーダーに作成された変更オーダーのステータスです。 -
ChangeOrderStatusCode: string
読取り専用:
true
最大長:25
一括置換中に購買オーダーに作成された変更オーダーのステータス・コードです。 -
ExceptionFlag: boolean
読取り専用:
true
最大長:5
購買オーダー詳細の一括置換プロセスの実行中に例外が発生したことを示す属性。 -
InlineReplacementFlag: boolean
読取り専用:
true
最大長:1
一括置換の対象となる購買オーダー詳細に対して置換処理を実行するかどうかを示す属性です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OriginalCurrencyCode: string
読取り専用:
true
最大長:15
一括置換の対象となる当初購買オーダーの通貨コードです。 -
OriginalPO: string
読取り専用:
true
最大長:153
一括置換の対象となる元の購買オーダー番号、明細番号、スケジュール番号および配分番号の連結値。 -
OriginalPODistributionId: integer (int64)
読取り専用:
true
一括置換の対象となる元の購買オーダー配分を一意に識別する値。 -
OriginalPOHeaderId: integer (int64)
読取り専用:
true
一括置換の対象となる元の購買オーダー・ヘッダーを一意に識別する値。 -
OriginalPOLineId: integer (int64)
読取り専用:
true
一括置換の対象となる元の購買オーダー明細を一意に識別する値。 -
OriginalPOLineLocationId: integer (int64)
読取り専用:
true
一括置換の対象となる元の購買オーダー・スケジュールを一意に識別する値。 -
OriginalPrecision: integer (int32)
読取り専用:
true
当初購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値です。 -
OriginalPurchasingUOM: string
読取り専用:
true
最大長:25
一括置換の対象となる当初購買オーダー明細の購買単位の名前。 -
OriginalPurchasingUOMCode: string
読取り専用:
true
最大長:3
一括置換の対象となる当初購買オーダー明細の購買単位コードです。 -
OriginalSPN: string
読取り専用:
true
最大長:300
一括置換の対象となる元の購買オーダー明細のサプライヤ部品番号。 -
OriginalUnitPrice: number
読取り専用:
true
一括置換の対象となる当初購買オーダー明細の単価です。 -
Phase: string
読取り専用:
true
最大長:30
購買オーダー配分が置換処理または再稼働処理の一括更新を実行するかどうかを示す属性です。 -
PODetailId: integer (int64)
読取り専用:
true
置換処理が実行される購買オーダー詳細を一意に識別する値。 -
POStatus: string
読取り専用:
true
最大長:30
一括置換の対象となる購買オーダー配分の置換ステータスです。 -
QuantityDue: number
読取り専用:
true
一括置換の対象となる当初購買オーダー配分のオーダー数量です。 -
ReplacementAction: string
読取り専用:
true
最大長:30
一括置換の対象となる購買オーダー配分に対して実行される置換処理のタイプです。 -
ReplacementActionCode: string
読取り専用:
true
最大長:17
一括置換の対象となる購買オーダー配分に対して実行された置換処理のコードです。 -
ReplacementCurrencyCode: string
読取り専用:
true
最大長:15
一括置換プロセスによって作成された置換購買オーダーの通貨コードです。 -
ReplacementDetailId: integer (int64)
読取り専用:
true
置換タスクに対して作成された置換詳細を一意に識別する値。 -
ReplacementId: integer
読取り専用:
true
置換タスクを一意に識別する値。 -
ReplacementNumber: integer (int64)
読取り専用:
true
置換タスクの番号。 -
ReplacementPO: string
読取り専用:
true
最大長:153
一括置換プロセスで作成された置換購買オーダー番号、明細番号、スケジュール番号および配分番号の連結値。 -
ReplacementPODistributionId: integer (int64)
読取り専用:
true
一括置換プロセスで作成された置換購買オーダー配分を一意に識別する値。 -
ReplacementPOHeaderId: integer (int64)
読取り専用:
true
一括置換プロセスで作成された置換購買オーダー・ヘッダーを一意に識別する値。 -
ReplacementPOLineId: integer (int64)
読取り専用:
true
一括置換プロセスで作成された置換購買オーダー明細を一意に識別する値です。 -
ReplacementPOLineLocationId: integer (int64)
読取り専用:
true
一括置換プロセスによって作成された置換購買オーダー・スケジュールを一意に識別する値。 -
ReplacementPrecision: integer (int32)
読取り専用:
true
置換購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値です。 -
ReplacementPurchasingUOM: string
読取り専用:
true
最大長:25
一括置換プロセスで導出された置換購買オーダー明細の購買単位の名前。 -
ReplacementPurchasingUOMCode: string
読取り専用:
true
最大長:3
一括置換プロセスによって導出された置換購買オーダー明細の購買単位コードです。 -
ReplacementQuantityOrdered: number
読取り専用:
true
一括置換プロセスによって導出された置換購買オーダー配分のオーダー数量です。 -
ReplacementSPN: string
読取り専用:
true
最大長:300
一括置換プロセスによって導出された置換購買オーダー明細のサプライヤ部品番号。 -
ReplacementUnitPrice: number
読取り専用:
true
一括置換プロセスによって導出された置換購買オーダー明細の単価です。 -
ShipToOrganizationCode: string
読取り専用:
true
最大長:18
一括置換対象の購買オーダー・スケジュールが属する在庫組織のコード。 -
ShipToOrganizationId: integer (int64)
読取り専用:
true
一括置換対象の購買オーダー・スケジュールが属する出荷先組織を一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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/summaryOfMassReplacementPurchaseOrders"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
"{ "ReplacementId": 300100550613392, "ReplacementNumber": 5001, "ReplacementDetailId": 300100550613408, "PODetailId": 300100550613411, "Phase": "REPLACEMENT", "POStatus": "CREATED", "OriginalPO": "1005080-2-1-1", "ShipToOrganizationId": 300100200332056, "ShipToOrganizationCode": "HC02", "OriginalSPN": "SUP1020", "QuantityDue": 12, "OriginalPurchasingUOMCode": "Ea", "OriginalPurchasingUOM": "Each", "OriginalUnitPrice": 10, "OriginalCurrencyCode": "USD", "OriginalPrecision":2, "ReplacementActionCode": "CANCEL_AND_ADD_PO", "ReplacementAction": "Cancel and Add PO", "InlineReplacementFlag": "false", "OriginalPOHeaderId": 300100550608659, "OriginalPOLineId": 300100550608676, "OriginalPOLineLocationId": 300100550608677, "OriginalPODistributionId": 300100550608678, "ReplacementPOHeaderId": 300100550608659, "ReplacementPO": "1005080-3-1-1", "ChangeOrderStatusCode": "PROCESSED", "ChangeOrderStatus": "Processed", "ReplacementSPN": "SUP1021", "ReplacementPurchasingUOMCode": "B10", "ReplacementPurchasingUOM": "Box of 10", "ReplacementUnitPrice": 120, "ReplacementCurrencyCode": "USD", "ReplacementPrecision":2, "ReplacementQuantityOrdered": 1, "ReplacementPOLineId": 300100550613419, "ReplacementPOLineLocationId": 300100550613420, "ReplacementPODistributionId": 300100550613421, "ExceptionFlag": "false" } "