Jump to

• Request
• Response
• Examples

Update all lines

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/action/updateAllLines

Updates the header-level attributes of a change order header. The updated values are displayed for all the change order lines.

Request

Path Parameters

• draftPurchaseOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders 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

• initiatingParty: string
  Name of the party that requested the update on the change order. Valid values are buyer, requester, and supplier.
• updateAttributes: object updateAttributes
  Additional Properties Allowed: additionalProperties

  List of attributes to be updated. Using this action, you can update these attributes: DeliverToLocationId, RequesterId, RequestedDeliveryDate, and ChargeAccount.

{
    "type":"object",
    "properties":{
        "updateAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"List of attributes to be updated. Using this action, you can update these attributes: DeliverToLocationId, RequesterId, RequestedDeliveryDate, and ChargeAccount.",
            "nullable":true
        },
        "initiatingParty":{
            "type":"string",
            "description":"Name of the party that requested the update on the change order. Valid values are buyer, requester, and supplier.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : updateAttributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"List of attributes to be updated. Using this action, you can update these attributes: DeliverToLocationId, RequesterId, RequestedDeliveryDate, and ChargeAccount.",
    "nullable":true
}

List of attributes to be updated. Using this action, you can update these attributes: DeliverToLocationId, RequesterId, RequestedDeliveryDate, and ChargeAccount.

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 value of Success. Otherwise, it returns a value of Failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then this action returns a value of Success. Otherwise, it returns a value of Failure."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to mass-update attributes on lines of a requester-initiated change order.

Note:

The attributes mentioned in the example are the only attributes a requester can mass-update on a change order.

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/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID"

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.

{
	"name":"updateAllLines",
    "parameters":[ {
         
            "updateAttributes": {
                 "PJC_FLEX_Context": "PO_Purchase_Order",
              "_PROJECT_ID": 300100005141135,
                  "_TASK_ID": 300100005141202,
                  "_EXPENDITURE_ITEM_DATE": "2011-01-01",
                 "_EXPENDITURE_TYPE_ID": "10001",
                 "_ORGANIZATION_ID": 204,
                "RequestedDeliveryDate": "2028-06-27",
                 "RequesterId": "100010026864119",
                 "DeliverToLocationId": "300100574716628",             
                 "POChargeAccountId": "17347"                                          
            }
        },
        {
        "initiatingParty":"Requester"
        } 		
	]
}

Example Response Body

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

Success code 200

Back to Top