Update a work confirmation

patch

/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}

Request

Path Parameters
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages attachments for a work confirmation.
Show Source
Nested Schema : Document Actions
Type: array
Title: Document Actions
The Document Actions resource retrieves the list of actions performed on a work confirmation.
Show Source
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : workConfirmations-documentActions-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages attachments for a work confirmation.
Show Source
Nested Schema : Document Actions
Type: array
Title: Document Actions
The Document Actions resource retrieves the list of actions performed on a work confirmation.
Show Source
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.
Show Source
Nested Schema : workConfirmations-attachments-item-response
Type: object
Show Source
Nested Schema : workConfirmations-documentActions-item-response
Type: object
Show Source
Nested Schema : workConfirmations-lines-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to update a work confirmation.

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"
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/300100552047317"

Example Request Body

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.

{                                                                     {
    "PeriodStartDate": "2022-01-02",
    "PeriodEndDate": "2022-01-31",
    "WorkConfirmationRequestDate": "2022-02-01",
    "Comments": "Phase - I"
}"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "WorkConfirmationId": 300100552047317,
    "WorkConfirmationNumber": "1005070-13",
    "POHeaderId": 300100549056643,
    "OrderNumber": "1005070",
    "SoldToLegalEntityId": 204,
    "SoldToLegalEntity": "Vision Operations",
    "PeriodStartDate": "2022-01-02",
    "PeriodEndDate": "2022-01-31",
    "WorkConfirmationRequestDate": "2022-02-01T00:00:00+00:00",
    "Comments": "Phase - I",
    "StatusCode": "INCOMPLETE",
    "Status": "Incomplete",
    "WorkConfirmationSequenceNumber": 13,
    "CreationDate": "2022-02-02T10:16:06+00:00",
    "CreatedBy": "CVBUYER01",
    "LastUpdateDate": "2022-02-02T10:16:06.473+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "PODescription": "Contract for renovation of parking lot",
    "SupplierId": 1717,
    "Supplier": "CV_SuppA05",
    "SupplierSiteId": 4060,
    "SupplierSite": "CVSuppA05Site01",
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "ImportSource": null,
    "PreviouslyApprovedAmount": 10200,
    "ContractAmountToDate": 250000,
    "TotalCompletedThisPeriod": 0,
    "TotalCompletedToDate": 10200,
    "ProjectedRetainageThisPeriod": 0,
    "CurrentPaymentDue": 0,
    "BalanceToFinish": 239800,
    "BuyerId": 100010026863799,
    "Buyer": "Norden,Loraine",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317",
            "name": "workConfirmations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317",
            "name": "workConfirmations",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/attachments",
            "name": "attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/documentActions",
            "name": "documentActions",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/action/withdraw",
            "name": "withdraw",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/action/cancel",
            "name": "cancel",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100552047317/action/submit",
            "name": "submit",
            "kind": "other"
        }
    ]
}
Back to Top