機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

作業確認明細の更新

patch

/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/lines/{WorkConfirmationLineId}

リクエスト

パス・パラメータ

• WorkConfirmationLineId(required): integer(int64)
  作業確認明細を一意に識別する値。
• workConfirmationsUniqID(required): string
  これは、作業確認リソースのコンポジット・キーを構成し、作業確認のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは作業確認の特定のインスタンスに移動してハッシュ・キーを取得するために、作業確認コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• Amount: number
  期間または実績の分割払いスケジュールで完了した作業の金額。
• POLineId: integer (int64)
  購買オーダー明細を一意に識別する値。
• POLineLocationId: integer (int64)
  購買オーダー・スケジュールを一意に識別する値。
• POLineNumber: number
  タイトル: Line

  購買オーダー明細を一意に識別する番号です。
• POScheduleNumber: number
  タイトル: Schedule

  購買オーダー明細の購買オーダー・スケジュールを一意に識別する番号です。
• Quantity: number
  期間または実績の分割払いスケジュールで完了した作業の数量。
• TotalProgressPercent: number
  分割払いスケジュールで完了した作業のパーセントを示す値です。

{
    "type":"object",
    "properties":{
        "POScheduleNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TotalProgressPercent":{
            "type":"number",
            "description":"Value that indicates the percent of the work completed on a progress payment schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "POLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Amount":{
            "type":"number",
            "description":"Amount of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        }
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

• 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

  販売先法的エンティティの作業確認を一意に識別する番号です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the supplier or application created the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TotalProgressPercent":{
            "type":"number",
            "description":"Value that indicates the percent of the work completed on a progress payment schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the progress payment schedule type. Valid values are rate and lump sum.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Scheduled quantity of the progress payment schedule .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceToFinish":{
            "type":"number",
            "description":"Amount pending to complete the work on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCompleted":{
            "type":"number",
            "description":"Total amount of work completed on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation in a sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectedRetainageThisPeriod":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalProjectedRetainageToDate":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumRetainageAmount":{
            "title":"Maximum Retainage Amount",
            "type":"number",
            "description":"Maximum amount of retainage that can be withheld on a purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "RetainageRate":{
            "title":"Retainage Rate",
            "type":"number",
            "description":"Percentage of the invoice value that can be withheld as retainage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the quantity ordered on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Price of the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledValue":{
            "type":"number",
            "description":"Ordered amount on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviouslyApprovedAmount":{
            "type":"number",
            "description":"Total approved work confirmation amount of a progress payment schedule prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier or application most recently updated the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例

この例では、作業確認明細を更新する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationUniqId/child/lines/WorkConfirmationLineId"

たとえば:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276468"

リクエスト本文の例

この例では、作業確認明細の合計進捗率が正常に更新されています。

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。 リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。

"{
"TotalProgressPercent": 50,
}"

レスポンス本文の例

次の例には、レスポンス本文の内容が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"
                }
            ]
        }

「トップに戻る」