すべての行を取得
get
/fscmRestApi/resources/11.13.18.05/externalPurchasePrices/{HeaderId}/child/lines
リクエスト
パス・パラメータ
- HeaderId(required): integer(int64)
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey主キーに従って外部購買価格明細を検索します。
ファインダ変数- LineId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdjustedPrice; number; 調整後の単価の値。
- AdjustmentPercentage; number; 基準価格が調整されるパーセント値。
- CancelledFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、外部購買価格は取り消されます。 falseの場合、外部購買価格はアクティブです。 デフォルト値はfalseです。
- HeaderId; integer; 外部購買価格を一意に識別する値。
- ItemDescription; string; 品目の説明。
- ItemNumber; string; 項目を一意に識別する数値。
- LastUpdateDate; string; ユーザーが外部購買価格明細レコードを最後に更新した日時。
- LineEndDate; string; 外部購買価格明細を一意に識別する値。
- LineId; integer; 外部購入価格明細を一意に識別する番号。
- LineNumber; integer; 価格が無効になる日付。
- LineStartDate; string; 価格が有効になる日付。
- LineStatus; string; 外部購買価格明細のステータス。
- LineStatusCode; string; 外部購買価格明細のステータスを識別する略称。
- ManufacturerPartNumber; string; 製造業者部品を一意に識別する番号。
- ObjectVersionNumber; integer; 外部購買価格明細が更新された回数。
- Price; number; 修正前の単価の値。
- PurchaseAgreementFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、明細に対して購買契約明細が作成されます。 falseの場合、明細に対して購買契約明細は作成されません。 デフォルト値はfalseです。
- PurchaseAgreementNumber; string; 購買契約を一意に識別する番号。
- PurchasingCategoryId; integer; 購買カテゴリを一意に識別する値。
- PurchasingCategoryName; string; 購買カテゴリの名前。
- SelectionEnabledFlag; boolean; これらの値のいずれかを含みます: trueまたはfalse。 trueの場合、明細は選択に適格です。 falseの場合、明細は選択可能ではありません。 デフォルト値はtrueです。
- SupplierPartNumber; string; サプライヤ部品を一意に識別する番号。
- UOMCode; string; 単位を識別する略称。
- UnitOfMeasure; string; 単位の名前。
- UpdateFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、明細に未処理の更新が存在します。 falseの場合、明細に対する未処理の更新はありません。 デフォルト値はfalseです。
- UserSelectedFlag; boolean; これらの値のいずれかを含みます: trueまたはfalse。 trueの場合、購買契約を作成するための明細がユーザーによって選択されます。 falseの場合、行はユーザーによって選択されません。 デフォルト値はfalseです。
- ValidatedFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、明細は外部購買価格からの購買契約のインポート・プロセスで検証されます。 falseの場合、明細は検証されません。 デフォルト値はtrueです。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : externalPurchasePrices-lines
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : externalPurchasePrices-lines-item-response
タイプ:
ソースを表示
object
-
AdjustedPrice: number
読取り専用:
true
修正後の単価の値です。 -
AdjustmentPercentage: number
読取り専用:
true
基準価格が調整されるパーセント値。 -
CancelledFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、外部購買価格は取り消されます。 falseの場合、外部購買価格はアクティブです。 デフォルト値はfalseです。 -
HeaderId: integer (int64)
読取り専用:
true
外部購買価格を一意に識別する値です。 -
ItemDescription: string
読取り専用:
true
最大長:240
品目の摘要。 -
ItemNumber: string
読取り専用:
true
最大長:300
品目を一意に識別する番号です。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが外部購買価格明細レコードを最後に更新した日時。 -
LineEndDate: string (date)
読取り専用:
true
外部購買価格明細を一意に識別する値です。 -
LineId: integer (int64)
外部購買価格明細を一意に識別する番号です。
-
LineNumber: integer (int64)
読取り専用:
true
価格が無効になる日付。 -
LineStartDate: string (date)
読取り専用:
true
価格が有効になる日付。 -
LineStatus: string
タイトル:
Meaning
読取り専用:true
最大長:80
外部購買価格明細のステータスです。 -
LineStatusCode: string
読取り専用:
true
最大長:255
外部購買価格明細のステータスを識別する略称です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManufacturerPartNumber: string
読取り専用:
true
最大長:700
製造業者部品を一意に識別する番号。 -
ObjectVersionNumber: integer (int32)
外部購買価格明細が更新された回数。
-
Price: number
読取り専用:
true
修正前の単価の値です。 -
PurchaseAgreementFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、明細に対して購買契約明細が作成されます。 falseの場合、明細に対して購買契約明細は作成されません。 デフォルト値はfalseです。 -
PurchaseAgreementNumber: string
読取り専用:
true
最大長:255
購買契約を一意に識別する番号です。 -
PurchasingCategoryId: integer (int64)
読取り専用:
true
購買カテゴリを一意に識別する値。 -
PurchasingCategoryName: string
読取り専用:
true
最大長:2400
購買カテゴリの名前です。 -
SelectionEnabledFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、明細は選択に適格です。 falseの場合、明細は選択可能ではありません。 デフォルト値はtrueです。 -
SupplierPartNumber: string
読取り専用:
true
最大長:300
サプライヤ部品を一意に識別する番号。 -
UnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
単位の名前。 -
UOMCode: string
読取り専用:
true
最大長:3
単位を識別する略語。 -
UpdateFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、明細に未処理の更新が存在します。 falseの場合、明細に対する未処理の更新はありません。 デフォルト値はfalseです。 -
UserSelectedFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買契約を作成するための明細がユーザーによって選択されます。 falseの場合、行はユーザーによって選択されません。 デフォルト値はfalseです。 -
ValidatedFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、明細は外部購買価格からの購買契約のインポート・プロセスで検証されます。 falseの場合、明細は検証されません。 デフォルト値は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.