Purchase Request Service Version 1
Version 1 of a service allowing integrating applications to create, change, control, and get details about requisitions and purchase orders.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseRequestService/}PurchaseRequestService
Service WSDL URL: https://servername/fscmService/PurchaseRequestService?WSDL
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
Operations
getPurchaseRequest
An operation to get purchase request details.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
payload |
Purchase Request Get Version 1 |
The input parameter structure for the operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned after acting on the request for which the service was invoked. |
controlPurchaseRequest
An operation to perform a hold action on a requisition line, or to perform a hold or firm action on a purchase order schedule.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
payload |
Purchase Request Control Actions Version 1 |
The input parameter structure for the operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned after acting on the request for which the service was invoked. |
changePurchaseRequest
An operation to change a purchase request. Depending on the current state, the operation may cancel a requisition line, cancel a change, or cancel or split a purchase order schedule.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
payload |
Purchase Request Change Version 1 |
The input parameter structure for the operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned after acting on the request for which the service was invoked. |
submitImportRequisition
An operation to start the requisition import process, to complete the creation of the requisition with the data from the interface table. Calling applications should first load the interface table using the populateInterfaceTable operation, and then call the Purchase Request Web Service with the submitImportRequisition operation.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
interfaceSourceCode |
string |
A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV. |
|
batchId |
long |
The unique identifier of a batch of records that can be provided during job submission, and used to match the requisition lines that are selected for processing. |
|
requisitioningBUId |
long |
The unique identifier of a requisitioning business unit. |
|
requisitioningBUName |
string |
The display name of a requisitioning business unit. |
|
groupBy |
string |
A code indicating how the requisition lines are grouped when they are being processed by the import program. Requisition lines that are grouped together will be put on the same requisition header. Valid values include None, Buyer, Category, Item, Location, and Supplier. |
|
nextRequisitionNumber |
int |
The display number used to identify the next requisition number to be created. |
|
initiateApprovalAfterRequisitionImport |
string |
Indicates whether or not requisitions that are imported as incomplete will be submitted for approval right after the process completes. |
|
maximumBatchSize |
int |
If this parameter is provided, the requisition lines will be processed in batches with a size not greater than the maximum batch size. |
|
errorProcessingLevel |
string |
A code indicating whether processing should continue if an errors occurs. Valid values include All and Partial. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Purchase Request Create Requisition Header Confirmation Version 1 |
The purchase request create operation, requisition header output information. |
populateInterfaceTable
This operation is for when integrating applications have a high volume of supply requests, such as Planning, which may have thousands of requests for a single batch. The caller can call the Purchase Request Web Service with this operation multiple times to populate the interface table with the data to create requisitions. Once the interface table is fully loaded, the calling application must call the Purchase Request Web Service with the operation submit requisition import.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
interfaceSourceCode |
string |
A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV. |
|
batchId |
long |
The unique identifier of a batch of records that can be provided during job submission, and used to match the requisition lines that are selected for processing. |
|
purchaseRequestPayload |
Purchase Request Create Requisition Header Version 1 |
The purchase request create operation, requisition header output information. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
For the populate interface table operation, the web service output payload will return either Success or Failure. In the case of Failure, the interface table will not be populated with the records sent in the input payload. |
createRequisition
This operation combines populate interface table, and submit requisition import. It will write the attributes into the requisition interface tables, and then start the requisition import process to complete the creation of requisitions. The requisition import process will then perform the necessary derivation and validation logic on the requisition.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
interfaceSourceCode |
string |
A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV. |
|
requisitioningBUId |
long |
The unique identifier of a requisitioning business unit. |
|
requisitioningBUName |
string |
The display name of a requisitioning business unit. |
|
groupBy |
string |
A code indicating how the requisition lines are grouped when they are being processed by the import program. Requisition lines that are grouped together will be put on the same requisition header. Valid values include None, Buyer, Category, Item, Location, and Supplier. |
|
nextRequisitionNumber |
int |
The display number used to identify the next requisition number to be created. |
|
initiateApprovalAfterRequisitionImport |
string |
Indicates whether or not requisitions that are imported as incomplete will be submitted for approval right after the process completes. |
|
maximumBatchSize |
int |
If this parameter is provided, the requisition lines will be processed in batches with a size not greater than the maximum batch size. |
|
errorProcessingLevel |
string |
A code indicating whether processing should continue if an errors occurs. Valid values include All and Partial. |
|
purchaseRequestPayload |
Purchase Request Create Requisition Header Version 1 |
The purchase request create operation, requisition header output information. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
Purchase Request Create Requisition Header Confirmation Version 1 |
The purchase request create operation, requisition header output information. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
populateInterfaceTable |
PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Manage Purchase Request by Web Service |
Allows management of purchase requests using web service. |
|
submitImportRequisition |
PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Manage Purchase Request by Web Service |
Allows management of purchase requests using web service. |
|
getPurchaseRequest |
PO_SEARCH_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Search Purchase Request by Web Service |
Allows searching for purchase requests using the web service. |
|
controlPurchaseRequest |
PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Manage Purchase Request by Web Service |
Allows management of purchase requests using web service. |
|
createRequisition |
PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Manage Purchase Request by Web Service |
Allows management of purchase requests using web service. |
|
changePurchaseRequest |
PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV |
Manage Purchase Request by Web Service |
Allows management of purchase requests using web service. |