Create one approved supplier list source document
/fscmRestApi/resources/11.13.18.05/purchaseAgreementImportRequests/{InterfaceHeaderId}/child/businessUnitAccess
Request
-
InterfaceHeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
- application/json
object
-
BillToBU: string
Title:
Bill-to BU
Maximum Length:240
Value that identifies the business unit that processes supplier invoices for the purchasing document. -
BillToBUId: integer
(int64)
Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
-
BillToLocation: string
Title:
Bill-to Location
Maximum Length:60
Value that identifies the bill-to location where the supplier sends the invoice. -
BillToLocationId: integer
(int64)
Value that uniquely identifies the bill-to location.
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Contains one of the following values: true or false. If true, then the business unit assignment record on the agreement is enabled. If false, then business unit assignment record on the agreement is disabled. This attribute doesn't have a default value. -
InterfaceBUAssignmentId: integer
(int64)
Value that uniquely identifies the interface business unit access assignment of an agreement.
-
InterfaceBUAssignmentKey: string
Maximum Length:
50
Value that uniquely identifies the interface business unit access assignment of an agreement. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header of the business unit access assignment of an agreement.
-
InterfaceHeaderKey: string
Maximum Length:
50
Value that uniquely identifies the interface header of the business unit access assignment of an agreement. -
OrderLocallyFlag: boolean
Title:
Order Locally
Maximum Length:1
Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value. -
PurchasingSite: string
Title:
Purchasing Site
Maximum Length:240
Value that uniquely identifies the supplier site for the purchasing operating unit. -
PurchasingSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the purchasing operating unit.
-
RequisitioningBU: string
Title:
Requisitioning BU
Maximum Length:240
Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that requested the goods or services being purchased.
-
ShipToLocation: string
Title:
Ship-to Location
Maximum Length:60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
Response
- application/json
Default Response
-
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.
object
-
BillToBU: string
Title:
Bill-to BU
Maximum Length:240
Value that identifies the business unit that processes supplier invoices for the purchasing document. -
BillToBUId: integer
(int64)
Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
-
BillToLocation: string
Title:
Bill-to Location
Maximum Length:60
Value that identifies the bill-to location where the supplier sends the invoice. -
BillToLocationId: integer
(int64)
Value that uniquely identifies the bill-to location.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the business unit access on the purchase agreement -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase agreement. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Contains one of the following values: true or false. If true, then the business unit assignment record on the agreement is enabled. If false, then business unit assignment record on the agreement is disabled. This attribute doesn't have a default value. -
InterfaceBUAssignmentId: integer
(int64)
Value that uniquely identifies the interface business unit access assignment of an agreement.
-
InterfaceBUAssignmentKey: string
Maximum Length:
50
Value that uniquely identifies the interface business unit access assignment of an agreement. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header of the business unit access assignment of an agreement.
-
InterfaceHeaderKey: string
Maximum Length:
50
Value that uniquely identifies the interface header of the business unit access assignment of an agreement. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application last updated the business unit access of a purchase agreement. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who created the business unit access on the purchase agreement -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderLocallyFlag: boolean
Title:
Order Locally
Maximum Length:1
Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status. -
PurchasingSite: string
Title:
Purchasing Site
Maximum Length:240
Value that uniquely identifies the supplier site for the purchasing operating unit. -
PurchasingSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the purchasing operating unit.
-
RequisitioningBU: string
Title:
Requisitioning BU
Maximum Length:240
Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that requested the goods or services being purchased.
-
ShipToLocation: string
Title:
Ship-to Location
Maximum Length:60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create a business unit assignment for an agreement. This step populates the interface tables with the agreement business unit access data.
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/purchaseAgreementImportRequests/InterfaceHeaderId/child/businessUnitAccess"
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.
{ "RequisitioningBU": "Vision Operations", "OrderLocallyFlag": false, "PurchasingSite": "CVSuppA01Site01", "ShipToLocation": "V1- New York City", "BillToBU": "Vision Operations", "BillToLocation": "V1 - Vision Operations", "EnabledFlag": true }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "InterfaceBUAssignmentId" : 300100590200172, "InterfaceHeaderId" : 300100590192348, "InterfaceHeaderKey" : null, "InterfaceBUAssignmentKey" : null, "RequisitioningBUId" : null, "RequisitioningBU" : "Vision Operations", "OrderLocallyFlag" : false, "PurchasingSiteId" : null, "PurchasingSite" : "CVSuppA01Site01", "ShipToLocationId" : null, "ShipToLocation" : "V1- New York City", "BillToBUId" : null, "BillToBU" : "Vision Operations", "BillToLocationId" : null, "BillToLocation" : "V1 - Vision Operations", "EnabledFlag" : true, "CreatedBy" : "PRC_INTEGRATION_USER", "CreationDate" : "2024-01-17T06:35:53.002+00:00", "LastUpdatedBy" : "PRC_INTEGRATION_USER", "LastUpdateDate" : "2024-01-17T06:35:53.002+00:00", "ProcessCode" : null, "RequestId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348/child/businessUnitAccess/300100590200172", "name" : "businessUnitAccess", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348/child/businessUnitAccess/300100590200172", "name" : "businessUnitAccess", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348", "name" : "purchaseAgreementImportRequests", "kind" : "item" } ] }