すべての変更オーダーの取得
get
/fscmRestApi/resources/11.13.18.05/externalPurchasePricesChangeOrders
リクエスト
問合せパラメータ
- 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主キーに従って変更オーダーを検索します。
ファインダ変数- HeaderChangeId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- Action; string; 外部購買価格の変更オーダーで実行する処理。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。
- ApprovalDetailStatus; string; 変更オーダーの詳細ステータス。
- ApprovalStatus; string; 変更オーダーのステータス。
- ApprovalStatusCode; string; 変更オーダーのステータスを識別する略称。
- BPMApprovalStatusCode; string; 外部購買価格または変更オーダーのBPM承認タスクのステータスを識別する略称(承認待ち、否認済、取下済など)。
- ChangeOrderNumber; integer; 変更オーダーを識別する数値。
- ChangeOrderType; string; 変更オーダーのタイプ。
- CreationDate; string; ユーザーが変更オーダーを作成した日時。
- CurrencyCode; string; 変更オーダーの通貨を識別する略称。
- EndDate; string; 変更オーダーが無効になる日付。
- ExternalPurchasePricesNumber; integer; 外部購買価格を一意に識別する数値。
- HeaderChangeId; integer; 変更オーダーを一意に識別する値。
- LastUpdateDate; string; ユーザーが変更オーダー・レコードを最後に更新した日時。
- LinesAdded; string; 変更オーダーによって外部購買価格に追加された明細数。
- LinesCancelled; string; 変更オーダーによって外部購買価格で取り消された明細数。
- LinesUpdated; string; 変更オーダーによって外部購買価格で更新された明細数。
- ManufacturerName; string; 製造元の名前。
- ObjectVersionNumber; integer; 変更オーダーが更新された回数。
- OldEndDate; string; 変更オーダーが無効になる日付の古い値。
- OldSource; string; ソース契約の個人または組織の名前の古い値。
- OldSourceContractDescription; string; ソース契約の説明の古い値。
- OldSourceContractNumber; string; ソース契約を一意に識別する番号の古い値。
- OldSourceType; string; 契約のソース・タイプの古い値。
- OldStartDate; string; 変更オーダーが有効になる日付の古い値。
- OldTierDescription; string; ソース組織が属する層の説明の古い値。
- OldTierLevel; integer; ソース組織が属する層を示す数値の古い値。
- PendingApprovalExceptionFlag; boolean; これらの値のいずれかを含みます: trueまたはfalse。 trueの場合、外部購買価格承認は指定した期間を超えて待ち状態になります。 falseの場合、承認は指定した期間より前に保留されます。 デフォルト値はfalseです。
- ProcessedFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、変更オーダーが処理されます。 falseの場合、変更オーダーは処理されません。 この属性にはデフォルト値がありません。
- ProcurementBUId; integer; 調達ビジネス・ユニットを一意に識別する値。
- ProcurementBUName; string; 調達ビジネス・ユニットの名前。
- RequisitioningBUGroupId; integer; 購買依頼発行ビジネス・ユニットのグループを一意に識別する値。
- RequisitioningBUName; string; 購買依頼発行ビジネス・ユニットの名前です。
- Source; string; ソース契約の個人または組織の名前。
- SourceContractDescription; string; ソース契約の説明。
- SourceContractNumber; string; ソース契約を一意に識別する番号。
- SourceContractType; string; ソース契約のタイプ。
- SourceContractTypeCode; string; ソース契約のタイプを識別する略称。
- SourceReferenceId; string; ソース・アプリケーションの外部購入価格を一意に識別する値です。
- SourceType; string; 契約のソース・タイプ。
- StartDate; string; 変更オーダーが有効になる日付。
- SupplierId; integer; サプライヤを一意に識別する値。
- SupplierName; string; サプライヤの名前。
- SupplierNumber; string; サプライヤを一意に識別する数値。
- SupplierSite; string; サプライヤ・サイトの名前。
- SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
- TierDescription; string; ソース組織が属する層の説明。
- TierLevel; integer; ソース組織が属する層を示す数値。
- TotalLines; string; 変更オーダーの合計行数。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : externalPurchasePricesChangeOrders
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : externalPurchasePricesChangeOrders-item-response
タイプ:
ソースを表示
object
-
Action: string
最大長:
25
外部購買価格の変更オーダーで実行する処理です。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。 -
ApprovalDetailStatus: string
最大長:
30
変更オーダーの詳細ステータス。 -
ApprovalStatus: string
タイトル:
Meaning
読取り専用:true
最大長:80
変更オーダーのステータス。 -
ApprovalStatusCode: string
読取り専用:
true
最大長:255
変更オーダーのステータスを識別する略称です。 -
BPMApprovalStatusCode: string
最大長:
30
外部購買価格または変更オーダー(承認待ち、否認済、取下済など)のBPM承認タスクのステータスを識別する略称です。 -
ChangeOrderNumber: integer (int64)
変更オーダーを識別する番号。
-
ChangeOrderType: string
最大長:
30
変更オーダーのタイプです。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが変更オーダーを作成した日時。 -
CurrencyCode: string
最大長:
15
変更オーダーの通貨を識別する略称です。 -
EndDate: string (date)
変更オーダーが無効になる日付。
-
ExternalPurchasePricesNumber: integer (int64)
外部購買価格を識別する番号です。
-
HeaderChangeId: integer (int64)
変更オーダーを一意に識別する値。
-
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが変更オーダー・レコードを最後に更新した日時。 -
lines: array Lines
タイトル:
Lines
明細リソースは、外部購買価格の変更オーダー明細を管理します。 -
LinesAdded: string
読取り専用:
true
最大長:255
変更オーダーによって外部購買価格に追加された明細数。 -
LinesCancelled: string
読取り専用:
true
最大長:255
変更オーダーによって外部購買価格で取り消された明細数です。 -
LinesUpdated: string
読取り専用:
true
最大長:255
変更オーダーによって外部購買価格で更新された明細数。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManufacturerName: string
最大長:
700
製造業者の名前です。 -
ObjectVersionNumber: integer (int32)
変更オーダーが更新された回数。
-
OldEndDate: string
読取り専用:
true
変更オーダーが無効になる日付の旧値。 -
OldSource: string
読取り専用:
true
ソース契約の個人または組織の名前の旧値。 -
OldSourceContractDescription: string
読取り専用:
true
ソース契約の摘要の旧値。 -
OldSourceContractNumber: string
読取り専用:
true
ソース契約を一意に識別する番号の旧値。 -
OldSourceType: string
読取り専用:
true
契約のソース・タイプの旧値。 -
OldStartDate: string
読取り専用:
true
変更オーダーが有効になる日付の旧値。 -
OldTierDescription: string
読取り専用:
true
ソース組織が属する階層の摘要の旧値。 -
OldTierLevel: integer
読取り専用:
true
ソース組織が属する階層を示す旧数値。 -
PendingApprovalExceptionFlag: boolean
読取り専用:
true
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、外部購買価格承認は指定した期間を超えて待ち状態になります。 falseの場合、承認は指定した期間より前に保留されます。 デフォルト値はfalseです。 -
ProcessedFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、変更オーダーが処理されます。 falseの場合、変更オーダーは処理されません。 この属性にはデフォルト値がありません。 -
ProcurementBUId: integer (int64)
調達ビジネス・ユニットを一意に識別する値。
-
ProcurementBUName: string
タイトル:
Business Unit
読取り専用:true
最大長:240
調達ビジネス・ユニットの名前。 -
RequisitioningBUGroupId: integer (int64)
購買依頼発行ビジネス・ユニットのグループを一意に識別する値です。
-
RequisitioningBUName: string
読取り専用:
true
最大長:700
購買依頼発行ビジネス・ユニットの名前です。 -
Source: string
最大長:
60
ソース契約の個人または組織の名前。 -
SourceContractDescription: string
最大長:
2000
ソース契約の摘要。 -
SourceContractNumber: string
最大長:
120
ソース契約を一意に識別する番号。 -
SourceContractType: string
タイトル:
Meaning
読取り専用:true
最大長:80
ソース契約のタイプ。 -
SourceContractTypeCode: string
最大長:
30
ソース契約のタイプを識別する略称です。 -
SourceReferenceId: string
最大長:
30
ソース・アプリケーションの外部購買価格を一意に識別する値です。 -
SourceType: string
最大長:
60
契約のソース・タイプです。 -
StartDate: string (date)
変更オーダーが有効になる日付。
-
SupplierId: integer (int64)
サプライヤを一意に識別する値。
-
SupplierName: string
タイトル:
Name
読取り専用:true
最大長:360
サプライヤの名前。 -
SupplierNumber: string
タイトル:
Supplier Number
読取り専用:true
最大長:30
サプライヤを一意に識別する番号です。 -
SupplierSite: string
タイトル:
Site
読取り専用:true
最大長:240
サプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを一意に識別する値。
-
TierDescription: string
最大長:
2000
ソース組織が属する階層の摘要。 -
TierLevel: integer (int64)
ソース組織が属する階層を示す番号。
-
TotalLines: string
読取り専用:
true
最大長:255
変更オーダーの合計明細数。
ネストされたスキーマ : externalPurchasePricesChangeOrders-lines-item-response
タイプ:
ソースを表示
object
-
Action: string
タイトル:
Meaning
読取り専用:true
最大長:80
明細に対して実行する処理。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。 -
ActionCode: string
最大長:
25
明細に対して実行する処理を識別する略称です。 -
AdjustedPrice: number
修正後の単価の値です。
-
AdjustmentPercentage: number
基準価格が調整されるパーセント値。
-
CancelledFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、変更オーダーは取り消されます。 falseの場合、変更オーダーはアクティブです。 デフォルト値はtrueです。 -
CategoryName: string
読取り専用:
true
最大長:2400
購買カテゴリの名前です。 -
ErrorFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、変更オーダーにエラーが存在します。 falseの場合、変更オーダーにエラーはありません。 この属性にはデフォルト値がありません。 -
HeaderChangeId: integer (int64)
変更オーダーを一意に識別する値。
-
ItemDescription: string
最大長:
240
品目の摘要。 -
ItemNumber: string
最大長:
300
品目を一意に識別する番号です。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが変更オーダー明細レコードを最後に更新した日時。 -
LineChangeId: integer (int64)
変更オーダー明細を一意に識別する値。
-
LineEndDate: string (date)
変更オーダー明細が無効になる日付。
-
LineNumber: integer (int64)
変更オーダー明細を一意に識別する番号です。
-
LineStartDate: string (date)
変更オーダー明細が有効になる日付。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManufacturerPartNumber: string
最大長:
700
製造業者部品を一意に識別する番号。 -
ObjectVersionNumber: integer (int32)
変更オーダー明細が更新された回数。
-
OldAdjustedPrice: number
読取り専用:
true
修正後の単価の旧値。 -
OldAdjustmentPercentage: number
読取り専用:
true
基準価格が調整される旧パーセント値。 -
OldItemDescription: string
読取り専用:
true
品目の説明の古い値。 -
OldLineEndDate: string
読取り専用:
true
変更オーダー明細が無効になる日付の旧値。 -
OldLineStartDate: string
読取り専用:
true
変更オーダー明細が有効になる日付の旧値。 -
OldPrice: number
読取り専用:
true
修正前の単価の旧値。 -
OldVendorPartNumber: string
読取り専用:
true
サプライヤ部品を一意に識別する番号の旧値。 -
Price: number
修正前の単価の値です。
-
PurchasingCategoryId: integer (int64)
購買カテゴリを一意に識別する値。
-
SelectionEnabledFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、明細は選択に適格です。 falseの場合、明細は選択可能ではありません。 デフォルト値はtrueです。 -
SourceReferenceId: string
最大長:
30
ソース・アプリケーションの外部購買価格を一意に識別する値です。 -
UnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
単位の名前。 -
UOMCode: string
最大長:
3
単位を識別する略語。 -
UserSelectedFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買契約を作成するための明細がユーザーによって選択されます。 falseの場合、行はユーザーによって選択されません。 デフォルト値はfalseです。 -
VendorPartNumber: string
最大長:
300
サプライヤ部品を一意に識別する番号。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
リンク
- updateLineStatus
-
外部購買価格または変更オーダーの明細のステータスを更新します。