Get all source documents
get
/fscmRestApi/resources/11.13.18.05/massReplacementSourceDocumentsLOV
Request
Query Parameters
-
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 Find source documents according to the primary key.
Finder Variables- SupplierId; integer; Value that uniquely identifies the supplier for which source document exists.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
- UOMCode; string; Abbreviation that identifies the unit of measure in the source document.
- findByAlternateSupplier Find source documents according to the alternate supplier.
Finder Variables- bindGlobal; string;
- bindItemId; integer; Value that uniquely identifies the primary internal item.
- bindMpn; string; Value that uniquely identifies the alternate manufacturer part number sourced from the alternate supplier.
- bindPrcBuId; integer; Value that uniquely identifies the procurement business unit entity.
- bindReplacementId; integer;
- bindReqBuId; integer; Value that uniquely identifies the requisitioning business unit entity.
- bindVendorId; integer; Value that uniquely identifies the alternate supplier.
- bindVendorSiteId; integer; Value that uniquely identifies the supplier site corresponding to the alternate supplier.
- findByItemMpn Find source documents according to the alternate manufacturer part number.
Finder Variables- bindGlobal; string;
- bindItemId; integer; Value that uniquely identifies the substitute internal item.
- bindMpn; string; Value that uniquely identifies the alternate manufacturer part number.
- bindPrcBuId; integer; Value that uniquely identifies the procurement business unit.
- bindReplacementId; integer;
- bindReqBuId; integer;
- bindVendorId; integer; Value that uniquely identifies the supplier.
- bindVendorSiteId; integer; Value that uniquely identifies the supplier site based on the source document for the alternate manufacturer part number or substitute internal item.
- PrimaryKey Find source documents according to the 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:- CurrencyCode; string; Abbreviation that identifies the currency in the source document.
- ManufacturerPartNumber; string; Number that identifies the manufacturer part.
- Precision; integer; Value that indicates the number of digits to which the unit price attribute in the purchase order line must be rounded off.
- ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
- ProcurementBUName; string; Name of the procurement business unit.
- SourceDocument; string; Number that identifies the alternate source document header.
- SourceDocumentLine; number; Number that identifies the alternate source document line.
- SupplierId; integer; Value that uniquely identifies the supplier.
- SupplierName; string; Name of the supplier.
- SupplierPartNumber; string; Number that identifies the supplier part.
- SupplierSite; string; Name of the supplier site.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site.
- UOMCode; string; Abbreviation that identifies the unit of measure in the source document.
- UnitOfMeasure; string; Value of the unit of measure of the item in the alternate source document.
- UnitPrice; number; Value of the unit price of the item in the alternate source document.
-
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".
Header Parameters
-
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
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : massReplacementSourceDocumentsLOV
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : massReplacementSourceDocumentsLOV-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency in the source document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
Maximum Length:700
Number that identifies the manufacturer part. -
Precision: integer
(int32)
Title:
Precision
Read Only:true
Value that indicates the number of digits to which the unit price attribute in the purchase order line must be rounded off. -
ProcurementBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the procurement business unit. -
ProcurementBUName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the procurement business unit. -
SourceDocument: string
Title:
Order
Read Only:true
Maximum Length:30
Number that identifies the alternate source document header. -
SourceDocumentLine: number
Title:
Line
Read Only:true
Number that identifies the alternate source document line. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierName: string
Read Only:
true
Maximum Length:360
Name of the supplier. -
SupplierPartNumber: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Number that identifies the supplier part. -
SupplierSite: string
Title:
Site
Read Only:true
Maximum Length:240
Name of the supplier site. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Value of the unit of measure of the item in the alternate source document. -
UnitPrice: number
Title:
Price
Read Only:true
Value of the unit price of the item in the alternate source document. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
Abbreviation that identifies the unit of measure in the source document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all 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/massReplacementSourceDocumentsLOV"
Example 1
This example shows you how to get one or more source documents for item replacement using the findByAlternateSupplier finder.
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementSourceDocumentsLOV?finder=findByAlternateSupplier;bindPrcBuId=300100200125593,bindItemId=300100545303414,bindMpn=null,bindGlobal=N,bindVendorId=6134,bindVendorSiteId=300100203539381,bindReqBuId=300100200125593"
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
"{ "items" : [ { "SupplierName" : "Supplier 1001, Inc", "SupplierId" : 6133, "SupplierSite" : "NEW YORK", "SupplierSiteId" : 300100203539397, "SourceDocument" : "5", "SourceDocumentLine" : 1, "UnitOfMeasure" : "Each", "UOMCode" : "Ea", "UnitPrice" : 50, "CurrencyCode" : "USD", "ProcurementBUId" : 300100200125593, "ProcurementBUName" : "Vision Healthcare USA", "ManufacturerPartNumber" : "MFG2020" }]}"
Example 2
This example shows you how to get one or more source documents for item replacement using the findByItemMPN finder.
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementSourceDocumentsLOV?finder=findByItemMpn;bindPrcBuId=300100200125593,bindItemId=300100545303444,bindGlobal=Y,bindReplacementId=300100553817622"
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
"{ "items": [ { "SupplierName": "Supplier 1002", "SupplierId": 1, "SupplierSite": "Chicago", "SupplierSiteId": 985, "SourceDocument": "1000322", "SourceDocumentLine": 1, "UnitOfMeasure": "Each", "UOMCode": "Ea", "UnitPrice": 10, "CurrencyCode": "USD", "ProcurementBUId": 300100200125593, "ProcurementBUName": "Vision Healthcare USA", "ManufacturerPartNumber": null }] }"