Get all approved supplier list source documents
/fscmRestApi/resources/11.13.18.05/approvedSupplierListSourceDocuments
Request
-
effectiveDate: string
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
-
expand: string
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).
-
fields: string
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 -
finder: string
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 source documents according to their primary key.
Finder Variables- AslSourceDocumentsId; integer; Finds approved supplier list source documents according to the primary source document key.
- PrimaryKey Finds approved supplier list source documents according to their primary key.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- Agreement; string; Contract stating the terms of a purchase.
- AgreementId; integer; Identifier of the purchasing document's header.
- AgreementLine; number; Agreement line number with which the approved supplier list entry is associated.
- AgreementLineId; integer; Identifier of the purchasing document's line.
- AgreementType; string; Type of agreement associated with the requested item. Applicable types are blanket purchase agreement and contract purchase agreement.
- AgreementTypeCode; string; Code that indicates the type of document.
- AslId; integer; Unique identifier of the approved supplier list entry.
- AslSourceDocumentsId; integer; Identifier of the approved supplier list??s source document.
- 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.
- ScopeCode; 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.
- 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.
- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
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.
There's no request body for this operation.
Back to TopResponse
- 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
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
Agreement: string
Title:
Agreement
Maximum Length:30
Contract stating the terms of a purchase. -
AgreementEndDate: string
(date)
Title:
Agreement End Date
Read Only:true
Date after which the agreement isn't usable. -
AgreementId: integer
(int64)
Identifier of the purchasing document's header.
-
AgreementLine: number
Title:
Agreement Line
Agreement line number with which the approved supplier list entry is associated. -
AgreementLineId: integer
(int64)
Identifier of the purchasing document's line.
-
AgreementStartDate: string
(date)
Title:
Agreement Start Date
Read Only:true
Date on which the agreement associated with the approved supplier list entry becomes effective. -
AgreementStatus: string
Title:
Agreement Status
Read Only:true
Maximum Length:25
Indicates the state of the document with reference to the entire document lifecycle. For example, Incomplete, or Open. -
AgreementType: string
Title:
Type
Maximum Length:80
Type of agreement associated with the requested item. Applicable types are blanket purchase agreement and contract purchase agreement. -
AgreementTypeCode: string
Maximum Length:
25
Code that indicates the type of document. -
AslAttributesId: integer
Identifier of the approved supplier list??s supplier item attribute.
-
AslId: integer
(int64)
Unique identifier of the approved supplier list entry.
-
AslSourceDocumentsId: integer
Identifier of the approved supplier list??s source document.
-
DFF: array
DFF
-
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. -
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.
-
Scope: string
Title:
Scope
Read Only:true
Maximum Length:80
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. -
ScopeCode: string
Read Only:
true
Maximum Length:80
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. -
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)
Value that uniquely identifies the inventory organization that receives the item.
-
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
-
AslSourceDocumentsId: integer
-
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.
Examples
These examples describe how to get all approved supplier list source documents.
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/approvedSupplierListSourceDocuments/approvedSupplierListSourceDocumentsUniqID"
Example 1: Get All Source Documents
The following example describes how to get all source documents.
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/approvedSupplierListSourceDocuments?offset=0&limit=499&fields=ProcurementBU,ShipToOrganization,Supplier,SupplierSite,Item,AgreementType,Agreement,AgreementLine,AgreementStatus,AgreementStartDate,AgreementEndDate"
Example 1 Response Body
{ "items": [ { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Big Computers", "SupplierSite": "AND-BREDA_HQ", "Item": "CM15140", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Seven Corporation", "SupplierSite": "VLISSINGEN_HQ", "Item": "CM18759", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Vision Corporation", "SupplierSite": "VLISSINGEN_HQ", "Item": "CM18761", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "First Software", "SupplierSite": "AMSTERDAM_HQ", "Item": "CM31558", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, "count": 499, "hasMore": true, "limit": 499, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments", "name": "approvedSupplierListSourceDocuments", "kind": "collection" } ] }
Example 2: Get All Source Documents for a Supplier
The following example describes how to get all source documents for a supplier.
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/approvedSupplierListSourceDocuments?offset=0&limit=499&q=Supplier+LIKE+'Big+Computers*'&fields=ProcurementBU,ShipToOrganization,Supplier,SupplierSite,Item,AgreementType,Agreement,AgreementLine,AgreementStatus,AgreementStartDate,AgreementEndDate"
Example 2 Response Body
{ "items": [ { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "CM13139", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002839", "AgreementLine": 1, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "RCV-100", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002839", "AgreementLine": 2, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "CM13139", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002840", "AgreementLine": 1, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null } ], "count": 3, "hasMore": false, "limit": 499, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments", "name": "approvedSupplierListSourceDocuments", "kind": "collection" } ] }