Jump to

• Request
• Response
• Examples

Add lines to an existing work confirmation.

post

/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules/{purchaseOrderSchedulesUniqID}/action/confirmWork

Add lines to an existing work confirmation on the progress payment schedule. You can provide the quantity, amount, or percentage of work completed on the schedule for a performance period.

Request

Path Parameters

• purchaseOrderSchedulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Order Schedules resource and used to uniquely identify an instance of Purchase Order Schedules. The client should not generate the hash key value. Instead, the client should query on the Purchase Order Schedules collection resource in order to navigate to a specific instance of Purchase Order Schedules to get the hash key.

Header Parameters

• Effective-Of:
  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.
• 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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• amount: number
• quantity: number
• totalProgressPercent: number

{
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true
        },
        "quantity":{
            "type":"number",
            "nullable":true
        },
        "totalProgressPercent":{
            "type":"number",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the request is successful, then this action returns a confirmation message along with a work confirmation number.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a confirmation message along with a work confirmation number."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

The following examples describe how to add lines to an existing work confirmation.

Example cURL Command

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

curl -u username: password -X POST -H "Content-Type: application/json" -d "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/purchaseOrderSchedulesUniqID"

Example 1 Request Body

In this example, a work confirmation line is added to a draft work confirmation by providing the total progress percent.

The following example includes the contents of the request body in JSON format

"{
	"name": "confirmWork",
	"parameters": [
	{
		"totalProgressPercent": 80
	}
	]
}"

Example 1 Response Body

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

The progress was uploaded to work confirmation 1000135-1.

Example 2 Request Body

In this example, a work confirmation line is added to a draft work confirmation by providing the quantity.

The following example includes the contents of the request body in JSON format

"{
	"name": "confirmWork",
	"parameters": [
	{
		"quantity": 1000
	}
	]
}"

Example 2 Response Body

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

The progress was uploaded to work confirmation 1000135-1.

Example 3 Request Body

In this example, a work confirmation line is added to a draft work confirmation by providing the amount.

The following example includes the contents of the request body in JSON format

"{
	"name": "confirmWork",
	"parameters": [
	{
		"amount": 1000000
	}
	]
}"

Example 3 Response Body

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

The progress was uploaded to work confirmation 1000135-1.

Back to Top