すべての作業確認明細の取得
get
/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/lines
リクエスト
パス・パラメータ
- workConfirmationsUniqID(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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 作業確認明細識別子に従って、主キーとして作業確認明細を検索します。
ファインダ変数:- WorkConfirmationLineId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- BalanceToFinish; number; 分割払いスケジュールでの作業を完了するための保留中の金額。
- MaximumRetainageAmount; number; 購買オーダー明細で源泉徴収できる留保金の最大金額。
- POLineId; integer; 購買オーダー明細を一意に識別する値。
- POLineLocationId; integer; 購買オーダー・スケジュールを一意に識別する値。
- POLineNumber; number; 購買オーダー明細を一意に識別する番号。
- POScheduleDescription; string; 分割払いスケジュールに関連付けられた作業の説明。
- POScheduleNumber; number; 購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号。
- PreviouslyApprovedAmount; number; 現在のパフォーマンス期間より前の分割払いスケジュールの承認済作業確認の合計金額。
- Price; number; 購買オーダー・スケジュールの価格。
- ProjectedRetainageThisPeriod; number; パフォーマンス期間中に分割払いスケジュールで源泉徴収できる留保金額の見積。
- RetainageRate; number; 留保金として源泉徴収できる請求書値のパーセント。
- ScheduleTypeCode; string; 分割払いスケジュール・タイプを識別する略称。 有効な値は、レートと総額です。
- ScheduledQuantity; number; スケジュールされた分割払いスケジュールの数量。
- ScheduledValue; number; 分割払いスケジュールのオーダー金額。
- TotalCompleted; number; 分割払いスケジュールで完了した作業の合計金額。
- TotalProjectedRetainageToDate; number; 分割払いスケジュールで源泉徴収できる留保金額の見積。
- WorkConfirmationLineId; integer; 作業確認行を一意に識別する値。
- WorkConfirmationNumber; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : workConfirmations-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"の場合、推定行数は含まれません。
ネストされたスキーマ : workConfirmations-lines-item-response
タイプ:
ソースを表示
object
-
Amount: number
期間または実績の分割払いスケジュールで完了した作業の金額。
-
BalanceToFinish: number
読取り専用:
true
分割払いスケジュールでの作業を完了するための待ち状態の金額。 -
CreatedBy: string
読取り専用:
true
最大長:64
作業確認明細を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
サプライヤまたはアプリケーションが作業確認明細を作成した日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
サプライヤまたはアプリケーションが作業確認明細を最後に更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
作業確認明細を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumRetainageAmount: number
タイトル:
Maximum Retainage Amount
読取り専用:true
購買オーダー明細で源泉徴収可能な最大留保金額です。 -
POLineId: integer (int64)
購買オーダー明細を一意に識別する値。
-
POLineLocationId: integer (int64)
購買オーダー・スケジュールを一意に識別する値。
-
POLineNumber: number
タイトル:
Line
購買オーダー明細を一意に識別する番号です。 -
POScheduleDescription: string
タイトル:
Description
読取り専用:true
最大長:240
分割払いスケジュールに関連付けられた作業の摘要。 -
POScheduleNumber: number
タイトル:
Schedule
購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。 -
PreviouslyApprovedAmount: number
読取り専用:
true
現在のパフォーマンス期間前の分割払いスケジュールの承認済作業確認合計金額。 -
Price: number
タイトル:
Price
読取り専用:true
購買オーダー・スケジュールの価格です。 -
ProjectedRetainageThisPeriod: number
読取り専用:
true
パフォーマンス期間の分割払いスケジュールで源泉徴収できる留保金額の見積。 -
Quantity: number
期間または実績の分割払いスケジュールで完了した作業の数量。
-
RetainageRate: number
タイトル:
Retainage Rate
読取り専用:true
留保金として源泉徴収できる請求書値のパーセントです。 -
ScheduledQuantity: number
タイトル:
Quantity
読取り専用:true
分割払い予定の予定数量。 -
ScheduledValue: number
読取り専用:
true
分割払いスケジュールのオーダー金額。 -
ScheduleType: string
タイトル:
Meaning
読取り専用:true
最大長:80
分割払いスケジュールのタイプです。 -
ScheduleTypeCode: string
読取り専用:
true
最大長:30
分割払いスケジュール・タイプを識別する略称です。 有効な値は、レートと総額です。 -
TotalCompleted: number
読取り専用:
true
分割払いスケジュールで完了した作業の合計金額。 -
TotalProgressPercent: number
分割払いスケジュールで完了した作業のパーセントを示す値です。
-
TotalProjectedRetainageToDate: number
読取り専用:
true
分割払いスケジュールで源泉徴収できる留保金額の見積。 -
UOM: string
タイトル:
UOM Name
読取り専用:true
最大長:25
購買オーダー・スケジュールでオーダーされた数量の単位です。 -
UOMCode: string
読取り専用:
true
最大長:3
購買オーダー・スケジュールの単位を識別する略称です。 -
WorkConfirmationId: integer (int64)
読取り専用:
true
作業確認を一意に識別する値。 -
WorkConfirmationLineId: integer (int64)
読取り専用:
true
作業確認明細を一意に識別する値。 -
WorkConfirmationNumber: string
読取り専用:
true
最大長:30
販売先法的エンティティの作業確認を一意に識別する番号です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.