作業確認明細の作成
post
/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/lines
リクエスト
パス・パラメータ
- workConfirmationsUniqID(required): string
これは、作業確認リソースのコンポジット・キーを構成し、作業確認のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは作業確認の特定のインスタンスに移動してハッシュ・キーを取得するために、作業確認コレクション・リソースを問い合せる必要があります。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は有効日RESTリソースではサポートされていません。
サポートされているメディア・タイプ
- application/json
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
Amount: number
期間または実績の分割払いスケジュールで完了した作業の金額。
-
POLineId: integer (int64)
購買オーダー明細を一意に識別する値。
-
POLineLocationId: integer (int64)
購買オーダー・スケジュールを一意に識別する値。
-
POLineNumber: number
タイトル:
Line購買オーダー明細を一意に識別する番号です。 -
POScheduleNumber: number
タイトル:
Schedule購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。 -
Quantity: number
期間または実績の分割払いスケジュールで完了した作業の数量。
-
TotalProgressPercent: number
分割払いスケジュールで完了した作業のパーセントを示す値です。
レスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : 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.
例
次の例は、作業確認明細の作成方法を示しています。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationUniqId/child/lines"
例
例1
この例では、金額属性の値を指定することによって、総額スケジュールに対して作業確認明細が作成されます。
Example 1リクエスト本文
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{
"POLineNumber": 1,
"POScheduleNumber": 2,
"Amount": 5000,
}"
Example 1レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{
"WorkConfirmationLineId": 300100549276468,
"WorkConfirmationId": 300100549276467,
"POLineLocationId": 300100549072283,
"Amount": 5000,
"Quantity": null,
"TotalProgressPercent": 50,
"POLineId": 300100549056644,
"POScheduleNumber": 2,
"WorkConfirmationNumber": "1005070-1",
"POLineNumber": 1,
"CreationDate": "2022-01-10T15:24:03+00:00",
"CreatedBy": "CVSUPPA05",
"LastUpdateDate": "2022-01-10T15:47:26+00:00",
"LastUpdatedBy": "CVSUPPA05",
"POScheduleDescription": "Road Work",
"UOMCode": null,
"UOM": null,
"ScheduleTypeCode": "LUMPSUM",
"ScheduleType": "Lump Sum",
"PreviouslyApprovedAmount": 0,
"ProjectedRetainageThisPeriod": 500,
"ScheduledValue": 10000,
"TotalProjectedRetainageToDate": 500,
"TotalCompleted": 5000,
"BalanceToFinish": 5000,
"Price": null,
"MaximumRetainageAmount": 10000,
"RetainageRate": 10,
"ScheduledQuantity": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276468",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276468",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
"name": "workConfirmations",
"kind": "item"
}
]
}
例2
この例では、数量属性の値を指定することによって、レート・ベースのスケジュールに対して作業確認明細が作成されます。
Example 2リクエスト本文
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{
"POLineNumber": 1,
"POScheduleNumber": 1,
"Quantity": 100,
}"
Example 2レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{
"WorkConfirmationLineId": 300100549276469,
"WorkConfirmationId": 300100549276467,
"POLineLocationId": 300100549072275,
"Amount": 1000,
"Quantity": 100,
"TotalProgressPercent": 10,
"POLineId": 300100549056644,
"POScheduleNumber": 1,
"WorkConfirmationNumber": "1005070-1",
"POLineNumber": 1,
"CreationDate": "2022-01-10T15:24:03.039+00:00",
"CreatedBy": "CVSUPPA05",
"LastUpdateDate": "2022-01-10T15:24:03.103+00:00",
"LastUpdatedBy": "CVSUPPA05",
"POScheduleDescription": "Land scaping work - Floor 2",
"UOMCode": null,
"UOM": null,
"ScheduleTypeCode": "LUMPSUM",
"ScheduleType": "Lump Sum",
"PreviouslyApprovedAmount": 0,
"ProjectedRetainageThisPeriod": 100,
"ScheduledValue": 10000,
"TotalProjectedRetainageToDate": 100,
"TotalCompleted": 1000,
"BalanceToFinish": 9000,
"Price": 10,
"MaximumRetainageAmount": 10000,
"RetainageRate": 10,
"ScheduledQuantity": 1000,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276469",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276469",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
"name": "workConfirmations",
"kind": "item"
}
]
}
例3
この例では、進捗率合計属性の値を指定することによって、分割払いスケジュールの作業確認明細が作成されます。
Example 3リクエスト本文
次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。
"{
"POLineNumber": 1,
"POScheduleNumber": 3,
"TotalProgressPercent": 10,
}"
Example 3レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{
"WorkConfirmationLineId": 300100549276470,
"WorkConfirmationId": 300100549276467,
"POLineLocationId": 300100549056645,
"Amount": 1000,
"Quantity": null,
"TotalProgressPercent": 10,
"POLineId": 300100549056644,
"POScheduleNumber": 3,
"WorkConfirmationNumber": "1005070-1",
"POLineNumber": 1,
"CreationDate": "2022-01-10T15:24:03.081+00:00",
"CreatedBy": "CVSUPPA05",
"LastUpdateDate": "2022-01-10T15:24:03.106+00:00",
"LastUpdatedBy": "CVSUPPA05",
"POScheduleDescription": "Renovation of Parking Lot -Down payment",
"UOMCode": null,
"UOM": null,
"ScheduleTypeCode": "LUMPSUM",
"ScheduleType": "Lump Sum",
"PreviouslyApprovedAmount": 0,
"ProjectedRetainageThisPeriod": 100,
"ScheduledValue": 10000,
"TotalProjectedRetainageToDate": 100,
"TotalCompleted": 1000,
"BalanceToFinish": 9000,
"Price": null,
"MaximumRetainageAmount": 10000,
"RetainageRate": 10,
"ScheduledQuantity": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276470",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276470",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
"name": "workConfirmations",
"kind": "item"
}
]
}