Create one approved supplier list entry
/fscmRestApi/resources/11.13.18.05/procurementApprovedSupplierListEntries
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AslId: integer
(int64)
Unique identifier of the approved supplier list entry.
-
AslStatusId: integer
(int64)
Status identifier of the approved supplier list entry.
-
Comments: string
Maximum Length:
240
Comments entered for the approved supplier list entry. -
CountryOfOrigin: string
Title:
Country of Origin
Maximum Length:80
Country from which goods are exported. -
CountryOfOriginCode: string
Maximum Length:
2
Code that indicates the country from which goods are exported. -
DFF: array
DFF
-
DisableFlag: boolean
Title:
Disabled
Maximum Length:1
Mark indicating that the approved supplier list entry is no longer in use. -
FixedLotMultiple: number
Title:
Fixed Lot Multiple
Incremental quantity that must be used on purchase orders sourced from the approved supplier list entry. -
Item: string
Title:
Item
Maximum Length:300
Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the approved supplier list entry.
-
MinimumOrderQuantity: number
Title:
Minimum Order Quantity
Identifies the minimum quantity that can be purchased from the supplier on purchase orders sourced from the approved supplier list entry. -
PrimaryVendorItem: string
Title:
Supplier Item
Maximum Length:300
Identifies the supplier item number. -
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Business unit that manages and owns the purchasing document. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
-
PurchasingUOM: string
Title:
Purchasing UOM
Maximum Length:25
Unit of measure used on purchase orders sourced from the approved supplier list entry. -
PurchasingUOMCode: string
Maximum Length:
3
Code that indicates the unit of measure used on purchase orders sourced from the approved supplier list entry. -
ReviewDueDate: string
(date)
Date when the approved supplier list entry needs to be evaluated. This is generally used as a reminder for approving or recertifying the supplier for the specific item or category.
-
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization to which the supplier should ship the goods. -
ShipToOrganizationId: integer
(int64)
Default Value:
-1
Value that uniquely identifies the inventory organization that receives the item. -
Status: string
Title:
Status
Maximum Length:25
Approval status of the approved supplier list entry, representing whether the supplier is certified to supply the item or group of items. -
Supplier: string
Title:
Supplier
Maximum Length:360
Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who fulfills the order.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Entity that models how the buying organization conducts business with the supplier. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the location that the supplier uses to fulfill the order.
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
AslId: integer
(int64)
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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
-
AslCreationDate: string
(date-time)
Read Only:
true
Date on which the approved supplier list entry was created. -
AslId: integer
(int64)
Unique identifier of the approved supplier list entry.
-
AslScopeCode: string
Read Only:
true
Code that identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit. -
AslStatusId: integer
(int64)
Status identifier of the approved supplier list entry.
-
Comments: string
Maximum Length:
240
Comments entered for the approved supplier list entry. -
CountryOfOrigin: string
Title:
Country of Origin
Maximum Length:80
Country from which goods are exported. -
CountryOfOriginCode: string
Maximum Length:
2
Code that indicates the country from which goods are exported. -
DFF: array
DFF
-
DisableFlag: boolean
Title:
Disabled
Maximum Length:1
Mark indicating that the approved supplier list entry is no longer in use. -
FixedLotMultiple: number
Title:
Fixed Lot Multiple
Incremental quantity that must be used on purchase orders sourced from the approved supplier list entry. -
Item: string
Title:
Item
Maximum Length:300
Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the approved supplier list entry.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumOrderQuantity: number
Title:
Minimum Order Quantity
Identifies the minimum quantity that can be purchased from the supplier on purchase orders sourced from the approved supplier list entry. -
PrimaryVendorItem: string
Title:
Supplier Item
Maximum Length:300
Identifies the supplier item number. -
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Business unit that manages and owns the purchasing document. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
-
PurchasingUOM: string
Title:
Purchasing UOM
Maximum Length:25
Unit of measure used on purchase orders sourced from the approved supplier list entry. -
PurchasingUOMCode: string
Maximum Length:
3
Code that indicates the unit of measure used on purchase orders sourced from the approved supplier list entry. -
ReviewDueDate: string
(date)
Date when the approved supplier list entry needs to be evaluated. This is generally used as a reminder for approving or recertifying the supplier for the specific item or category.
-
Scope: string
Title:
Scope
Read Only:true
Maximum Length:255
Identifies if the approved supplier list entry is used by a ship-to organization or by all ship-to organizations serviced by the procurement business unit. -
ShipToOrganization: string
Title:
Ship-to Organization
Maximum Length:240
Name of the inventory organization to which the supplier should ship the goods. -
ShipToOrganizationId: integer
(int64)
Default Value:
-1
Value that uniquely identifies the inventory organization that receives the item. -
Status: string
Title:
Status
Maximum Length:25
Approval status of the approved supplier list entry, representing whether the supplier is certified to supply the item or group of items. -
Supplier: string
Title:
Supplier
Maximum Length:360
Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier who fulfills the order.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Entity that models how the buying organization conducts business with the supplier. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the location that the supplier uses to fulfill the order.
array
Links
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
-
AslId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
- DFF
-
Parameters:
- procurementApprovedSupplierListEntriesUniqID:
$request.path.procurementApprovedSupplierListEntriesUniqID
- procurementApprovedSupplierListEntriesUniqID:
Examples
These examples describe how to create one approved supplier list entry.
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/procurementApprovedSupplierListEntries"
Example 1
This example describes how to create a global approved supplier list entry with supplier item attribute values.
Example 1 Request Body
The following example includes the contents of the request body in JSON format:
{ "ProcurementBU": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "Austin", "Item": "CM13139", "Status": "Approved", "PrimaryVendorItem": null, "ReviewDueDate": null, "DisableFlag": null, "Comments": null, "PurchasingUOM": "Each", "CountryOfOrigin": "United States", "MinimumOrderQuantity": 2, "FixedLotMultiple": 4 }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "AslId": 300100564855279, "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "AslScopeCode": "GLOBAL", "Scope": "Global", "ShipToOrganizationId": -1, "ShipToOrganization": null, "Item": "CM13139", "ItemId": 249, "Supplier": "Big Computers", "SupplierId": 1225, "SupplierSite": "Austin", "SupplierSiteId": 1225, "PrimaryVendorItem": null, "Status": "Approved", "AslStatusId": 2, "ReviewDueDate": null, "DisableFlag": null, "Comments": null, "AslCreationDate": "2022-10-28T16:44:02.002-05:00", "PurchasingUOMCode": "Ea", "PurchasingUOM": "Each", "CountryOfOriginCode": "US", "CountryOfOrigin": "United States", "MinimumOrderQuantity": 2, "FixedLotMultiple": 4, "@context": { "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855279", "name": "procurementApprovedSupplierListEntries", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855279", "name": "procurementApprovedSupplierListEntries", "kind": "item" } ] } }
Example 2
This example describes how to create an organization-specific approved supplier list entry without supplier item attribute values.
Example 2 Request Body
The following example includes the contents of the request body in JSON format:
{ "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "Austin", "Item": "CM13139", "Status": "Approved", "PrimaryVendorItem": null, "ReviewDueDate": null, "DisableFlag": null, "Comments": null }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "AslId": 300100564855299, "ProcurementBUId": 204, "ProcurementBU": "Vision Operations", "AslScopeCode": "SHIP_TO_ORG", "Scope": "Ship-to Organization", "ShipToOrganizationId": 204, "ShipToOrganization": "Vision Operations", "Item": "CM13139", "ItemId": 249, "Supplier": "Big Computers", "SupplierId": 1225, "SupplierSite": "Austin", "SupplierSiteId": 2939, "PrimaryVendorItem": null, "Status": "Approved", "AslStatusId": 2, "ReviewDueDate": null, "DisableFlag": null, "Comments": null, "AslCreationDate": "2022-10-28T16:46:45.001-05:00", "PurchasingUOMCode": null, "PurchasingUOM": null, "CountryOfOriginCode": null, "CountryOfOrigin": null, "MinimumOrderQuantity": null, "FixedLotMultiple": null, "@context": { "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855299", "name": "procurementApprovedSupplierListEntries", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/300100564855299", "name": "procurementApprovedSupplierListEntries", "kind": "item" } ] } }