Jump to

• Request
• Response
• Examples

Update a work confirmation line

patch

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

Request

Path Parameters

• WorkConfirmationLineId(required): integer(int64)
  Value that uniquely identifies the work confirmation line.
• workConfirmationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Confirmations resource and used to uniquely identify an instance of Work Confirmations. The client should not generate the hash key value. Instead, the client should query on the Work Confirmations collection resource in order to navigate to a specific instance of Work Confirmations to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Amount: number
  Amount of work completed on a progress payment schedule for a period or performance.
• POLineId: integer (int64)
  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Value that uniquely identifies the purchase order schedule.
• POLineNumber: number
  Title: Line

  Number that uniquely identifies the purchase order line.
• POScheduleNumber: number
  Title: Schedule

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• Quantity: number
  Quantity of work completed on a progress payment schedule for a period or performance.
• TotalProgressPercent: number
  Value that indicates the percent of the work completed on a progress payment schedule.

{
    "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"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : workConfirmations-lines-item-response

Type: object

Show Source

• Amount: number
  Amount of work completed on a progress payment schedule for a period or performance.
• BalanceToFinish: number
  Read Only: true

  Amount pending to complete the work on a progress payment schedule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the work confirmation line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application created the work confirmation line.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application most recently updated the work confirmation line.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the work confirmation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumRetainageAmount: number
  Title: Maximum Retainage Amount

  Read Only: true

  Maximum amount of retainage that can be withheld on a purchase order line.
• POLineId: integer (int64)
  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Value that uniquely identifies the purchase order schedule.
• POLineNumber: number
  Title: Line

  Number that uniquely identifies the purchase order line.
• POScheduleDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• POScheduleNumber: number
  Title: Schedule

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• PreviouslyApprovedAmount: number
  Read Only: true

  Total approved work confirmation amount of a progress payment schedule prior to the current period of performance.
• Price: number
  Title: Price

  Read Only: true

  Price of the purchase order schedule.
• ProjectedRetainageThisPeriod: number
  Read Only: true

  Projected amount of retainage that can be withheld on the progress payment schedule for a period of performance.
• Quantity: number
  Quantity of work completed on a progress payment schedule for a period or performance.
• RetainageRate: number
  Title: Retainage Rate

  Read Only: true

  Percentage of the invoice value that can be withheld as retainage.
• ScheduledQuantity: number
  Title: Quantity

  Read Only: true

  Scheduled quantity of the progress payment schedule .
• ScheduledValue: number
  Read Only: true

  Ordered amount on the progress payment schedule.
• ScheduleType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of the progress payment schedule.
• ScheduleTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the progress payment schedule type. Valid values are rate and lump sum.
• TotalCompleted: number
  Read Only: true

  Total amount of work completed on a progress payment schedule.
• TotalProgressPercent: number
  Value that indicates the percent of the work completed on a progress payment schedule.
• TotalProjectedRetainageToDate: number
  Read Only: true

  Projected amount of retainage that can be withheld on the progress payment schedule.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the quantity ordered on the purchase order schedule.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure on the purchase order schedule.
• WorkConfirmationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work confirmation.
• WorkConfirmationLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work confirmation line.
• WorkConfirmationNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the work confirmation in a sold-to legal entity.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Back to Top

Examples

This example describes how to update a work confirmation line.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

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"

For example:

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"

Example Request Body

In this example, total progress percent on a work confirmation line is updated successfully.

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

"{
"TotalProgressPercent": 50,
}"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
            "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"
                }
            ]
        }

Back to Top