1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Procurement Approved Supplier List Entries

Get one approved supplier list entry

get

/fscmRestApi/resources/11.13.18.05/procurementApprovedSupplierListEntries/{procurementApprovedSupplierListEntriesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Procurement Approved Supplier List Entries resource and used to uniquely identify an instance of Procurement Approved Supplier List Entries. The client should not generate the hash key value. Instead, the client should query on the Procurement Approved Supplier List Entries collection resource in order to navigate to a specific instance of Procurement Approved Supplier List Entries to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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.
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : procurementApprovedSupplierListEntries-item-response
Type: object
Show Source
  • Read Only: true
    Date on which the approved supplier list entry was created.
  • Unique identifier of the approved supplier list entry.
  • 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.
  • Status identifier of the approved supplier list entry.
  • Maximum Length: 240
    Comments entered for the approved supplier list entry.
  • Title: Country of Origin
    Maximum Length: 80
    Country from which goods are exported.
  • Maximum Length: 2
    Code that indicates the country from which goods are exported.
  • DFF
  • Title: Disabled
    Maximum Length: 1
    Mark indicating that the approved supplier list entry is no longer in use.
  • Title: Fixed Lot Multiple
    Incremental quantity that must be used on purchase orders sourced from the approved supplier list entry.
  • Title: Item
    Maximum Length: 300
    Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies.
  • Value that uniquely identifies the item on the approved supplier list entry.
  • Links
  • 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.
  • Title: Supplier Item
    Maximum Length: 300
    Identifies the supplier item number.
  • Title: Procurement BU
    Maximum Length: 240
    Business unit that manages and owns the purchasing document.
  • Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
  • Title: Purchasing UOM
    Maximum Length: 25
    Unit of measure used on purchase orders sourced from the approved supplier list entry.
  • Maximum Length: 3
    Code that indicates the unit of measure used on purchase orders sourced from the approved supplier list entry.
  • 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.
  • 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.
  • Title: Ship-to Organization
    Maximum Length: 240
    Name of the inventory organization to which the supplier should ship the goods.
  • Default Value: -1
    Value that uniquely identifies the inventory organization that receives the item.
  • 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.
  • Title: Supplier
    Maximum Length: 360
    Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.
  • Value that uniquely identifies the supplier who fulfills the order.
  • Title: Supplier Site
    Maximum Length: 240
    Entity that models how the buying organization conducts business with the supplier.
  • Value that uniquely identifies the location that the supplier uses to fulfill the order.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : procurementApprovedSupplierListEntries-DFF-item-response
Type: object
Show Source
Links
DFF
Parameters:
  • procurementApprovedSupplierListEntriesUniqID: $request.path.procurementApprovedSupplierListEntriesUniqID
Back to Top

Examples

These examples describe how to get 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 "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/procurementApprovedSupplierListEntriesUniqID"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/1235"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "AslId": 1235,
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Operations",
    "AslScopeCode": "SHIP_TO_ORG",
    "Scope": "Ship-to Organization",
    "ShipToOrganizationId": 911,
    "ShipToOrganization": "Vision Germany",
    "Item": "AS54888",
    "ItemId": 149,
    "Supplier": "General Electric",
    "SupplierId": 3,
    "SupplierSite": "HAMBURG_HQ",
    "SupplierSiteId": 355,
    "PrimaryVendorItem": null,
    "Status": "Approved",
    "AslStatusId": 2,
    "ReviewDueDate": null,
    "DisableFlag": true,
    "Comments": null,
    "AslCreationDate": "2002-01-17T09:07:09+00:00",
    "PurchasingUOMCode": "Ea",
    "PurchasingUOM": "Each",
    "CountryOfOriginCode": "US",
    "CountryOfOrigin": "United States",
    "MinimumOrderQuantity": 2,
    "FixedLotMultiple": 4,
    "@context": {
        "key": "1235",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/1235",
                "name": "procurementApprovedSupplierListEntries",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries/1235",
                "name": "procurementApprovedSupplierListEntries",
                "kind": "item"
            }
        ]
    }
}
Back to Top