Get all approved supplier list entries

get

/fscmRestApi/resources/11.13.18.05/procurementApprovedSupplierListEntries

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds approved supplier list entries according to their primary key.
      Finder Variables
      • AslId; integer; Unique identifier of the approved supplier list entry.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AslId; integer; Unique identifier of the approved supplier list entry.
    • AslScopeCode; string; 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; Status identifier of the approved supplier list entry.
    • DisableFlag; boolean; Mark indicating that the approved supplier list entry is no longer in use.
    • Item; string; Anything that a business makes, purchases, or sells, including components, subassemblies, finished products, or supplies.
    • ItemId; integer; Value that uniquely identifies the item on the approved supplier list entry.
    • ProcurementBU; string; Business unit that manages and owns the purchasing document.
    • ProcurementBUId; integer; Value that uniquely identifies the business unit that manages and owns the approved supplier list entry.
    • Scope; string; 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; Name of the inventory organization to which the supplier should ship the goods.
    • ShipToOrganizationId; integer; Value that uniquely identifies the inventory organization that receives the item.
    • Status; string; Approval status of the approved supplier list entry, representing whether the supplier is certified to supply the item or group of items.
    • Supplier; string; Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.
    • SupplierId; integer; Value that uniquely identifies the supplier who fulfills the order.
    • SupplierSite; string; Entity that models how the buying organization conducts business with the supplier.
    • SupplierSiteId; integer; Value that uniquely identifies the location that the supplier uses to fulfill the order.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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
Back to Top

Examples

These examples describe how to get all approved supplier list entries.

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"

Example 1: Get Approved Supplier List Entries

The following example describes how to get all approved supplier list entries.

Example 1 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?offset=0&limit=499&fields=ProcurementBU,ShipToOrganization,Supplier,SupplierSite,Item,AslCreationDate,Status,PrimaryVendorItem,ReviewDueDate,DisableFlag,Comments"

Example 1 Response Body

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

{
  "items": [
    {
      "ProcurementBU": "Vision Operations",
      "ShipToOrganization": null,
      "Supplier": "Big Computers",
      "SupplierSite": "POZ12179",
      "Item": "SCC-TMC-04",
      "AslCreationDate": "2017-02-27T19:04:04.966-06:00",
      "Status": "Approved",
      "PrimaryVendorItem": "Supplier Item SCC-TMC-04 POZ12179",
      "ReviewDueDate": null,
      "DisableFlag": false,
      "Comments": null,
      "PurchasingUOMCode": "Ea",
      "PurchasingUOM": "Each",
      "CountryOfOriginCode": "US",
      "CountryOfOrigin": "United States",
      "MinimumOrderQuantity": 2,
      "FixedLotMultiple": 4
    },
    {
      "ProcurementBU": "Vision Operations",
      "ShipToOrganization": null,
      "Supplier": "Vision Corporation",
      "SupplierSite": "POZ12179",
      "Item": "SCC-TMC-01",
      "AslCreationDate": "2017-02-27T18:39:23.001-06:00",
      "Status": "Approved",
      "PrimaryVendorItem": "Supplier Item SCC-TMC-01",
      "ReviewDueDate": null,
      "DisableFlag": false,
      "Comments": null,
      "PurchasingUOMCode": "Ea",
      "PurchasingUOM": "Each",
      "CountryOfOriginCode": "US",
      "CountryOfOrigin": "United States",
      "MinimumOrderQuantity": 5,
      "FixedLotMultiple": 7
    },
    {
      "ProcurementBU": "Vision Operations",
      "ShipToOrganization": null,
      "Supplier": "First Software",
      "SupplierSite": "POZ12179",
      "Item": "SCC-TMC-03",
      "AslCreationDate": "2017-02-27T18:53:29.688-06:00",
      "Status": "Approved",
      "PrimaryVendorItem": "Supplier Item SCC-TMC-03 POZ12179",
      "ReviewDueDate": null,
      "DisableFlag": false,
      "Comments": null,
      "PurchasingUOMCode": null,
      "PurchasingUOM": null,
      "CountryOfOriginCode": "US",
      "CountryOfOrigin": "United States",
      "MinimumOrderQuantity": null,
      "FixedLotMultiple": null
    },
  "count": 499,
  "hasMore": true,
  "limit": 499,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries",
      "name": "procurementApprovedSupplierListEntries",
      "kind": "collection"
    }
  ]
}

Example 2: Get All Approved Supplier List Entries for a Procurement BU and Ship-to Organization

The following example describes how to get all approved supplier list entries for a procurement BU and ship-to organization.

Example 2 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?offset=0&limit=499&q=ProcurementBU+LIKE+'Vision+Operations*'+AND+ShipToOrganization+LIKE+'Vision+Operations*'"

Example 2 Response Body

The following example includes the contents of the response body in JSON format:
{
  "items": [
    {
      "ProcurementBU": "Vision Operations",
      "ShipToOrganization": "Vision Operations",
      "Supplier": "Big Computers",
      "SupplierSite": "POZ12179",
      "Item": "SCC-TMC-04",
      "AslCreationDate": "2017-02-27T19:04:04.966-06:00",
      "Status": "Approved",
      "PrimaryVendorItem": "Supplier Item SCC-TMC-04 POZ12179",
      "ReviewDueDate": null,
      "DisableFlag": false,
      "Comments": null,
      "PurchasingUOMCode": "Ea",
      "PurchasingUOM": "Each",
      "CountryOfOriginCode": "US",
      "CountryOfOrigin": "United States",
      "MinimumOrderQuantity": 2,
      "FixedLotMultiple": 4
    },
    {
      "ProcurementBU": "Vision Operations",
      "ShipToOrganization": "Vision Operations",
      "Supplier": "Vision Corporation",
      "SupplierSite": "POZ12179",
      "Item": "SCC-TMC-01",
      "AslCreationDate": "2017-02-27T18:39:23.001-06:00",
      "Status": "Approved",
      "PrimaryVendorItem": "Supplier Item SCC-TMC-01",
      "ReviewDueDate": null,
      "DisableFlag": false,
      "Comments": null,
      "PurchasingUOMCode": "Ea",
      "PurchasingUOM": "Each",
      "CountryOfOriginCode": "US",
      "CountryOfOrigin": "United States",
      "MinimumOrderQuantity": 5,
      "FixedLotMultiple": 7
    },
  "count": 499,
  "hasMore": true,
  "limit": 499,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername/fscmRestApi/resources/version/procurementApprovedSupplierListEntries",
      "name": "procurementApprovedSupplierListEntries",
      "kind": "collection"
    }
  ]
}
Back to Top