Get all quantities
get
/fscmRestApi/resources/11.13.18.05/collaborationSupplierOnHandQuantities
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 collaboration supplier on-hand quantities according to the supplier on-hand identifier.
Finder Variables- SupplierOnHandId; integer; Value that uniquely identifies the supplier on-hand quantity.
- PrimaryKey Find collaboration supplier on-hand quantities according to the supplier on-hand identifier.
-
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:- BaseQuantity; number; Quantity of the on-hand inventory for the item in the base unit of measure.
- BaseUOMCode; string; Abbreviation that identifies the base unit of measure for the item.
- BaseUnitOfMeasure; string; Base unit of measure for the item.
- CollaborationItemId; integer; Value that uniquely identifies the collaboration item for the supplier on-hand quantity.
- CreatedBy; string; User who created the on-hand quantity.
- CreationDate; string; Date and time when the user created the on-hand quantity.
- InventoryItemId; integer; Value that uniquely identifies the inventory item for the supplier on-hand quantity.
- ItemNumber; string; Number that identifies the item.
- LastUpdateDate; string; Date and time when the user most recently updated the on-hand quantity.
- LastUpdatedBy; string; Login of the user who most recently updated the on-hand quantity.
- PlanningItemId; integer; Value that uniquely identifies the planning item for the supplier on-hand quantity.
- ProcurementBUId; integer; Value that uniquely identifies the business unit.
- ProcurementBUName; string; Name of the business unit. The application assigns the supplier to this business unit.
- PublishSource; string; Value that indicates the type of user who performed the publish action. Values include Enterprise or Supplier.
- PublishSourceCode; string; Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task.
- PublishedBy; string; User who most recently published the on-hand quantity.
- PublishedDate; string; Date when the on-hand quantity was published.
- Quantity; number; Quantity of the on-hand inventory for the item.
- SupplierId; integer; Value that uniquely identifies the supplier in the collaboration order forecast. This supplier sends the shipment. It's a primary key that the application generates when it creates the supplier.
- SupplierItemNumber; string; Number that identifies the item referred to by the supplier.
- SupplierName; string; Name of the supplier that holds the on-hand inventory for the item.
- SupplierOnHandId; integer; Value that uniquely identifies the supplier on-hand quantity.
- SupplierSiteId; integer; Value that uniquely identifies the supplier site. This supplier site holds the on-hand inventory for the item. It's a primary key that the application generates when it creates the supplier site.
- SupplierSiteName; string; Name of the supplier site that holds the on-hand inventory for the item.
- UOMCode; string; Abbreviation that identifies the unit of measure for the item.
- UnitOfMeasure; string; Unit of measure for the item.
-
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:
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.
Root Schema : collaborationSupplierOnHandQuantities
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 : collaborationSupplierOnHandQuantities-item-response
Type:
Show Source
object
-
BaseQuantity: number
Read Only:
true
Quantity of the on-hand inventory for the item in the base unit of measure. -
BaseUnitOfMeasure: string
Read Only:
true
Maximum Length:255
Base unit of measure for the item. -
BaseUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the base unit of measure for the item. -
CollaborationItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the collaboration item for the supplier on-hand quantity. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the on-hand quantity. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the on-hand quantity. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item for the supplier on-hand quantity. -
ItemNumber: string
Number that identifies the item.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the on-hand quantity. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:32
Login of the user who most recently updated the on-hand quantity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanningItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the planning item for the supplier on-hand quantity. -
ProcurementBUId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Value that uniquely identifies the business unit. -
ProcurementBUName: string
Name of the business unit. The application assigns the supplier to this business unit.
-
PublishedBy: string
Read Only:
true
Maximum Length:255
User who most recently published the on-hand quantity. -
PublishedDate: string
(date-time)
Read Only:
true
Date when the on-hand quantity was published. -
PublishSource: string
Title:
Meaning
Read Only:true
Maximum Length:80
Value that indicates the type of user who performed the publish action. Values include Enterprise or Supplier. -
PublishSourceCode: string
Read Only:
true
Maximum Length:64
Default Value:ORA_VCS_ENTERPRISE_VAL
Abbreviation that identifies the type of user who performed the publish action. A list of accepted values is defined in the lookup type ORA_VCS_PARTY_ORIGIN. Review and update the values for this attribute using the Setup and Maintenance work area, and the Manage Supply Chain Collaboration Lookups task. -
Quantity: number
Quantity of the on-hand inventory for the item.
-
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier in the collaboration order forecast. This supplier sends the shipment. It's a primary key that the application generates when it creates the supplier. -
SupplierItemNumber: string
Number that identifies the item referred to by the supplier.
-
SupplierName: string
Maximum Length:
255
Name of the supplier that holds the on-hand inventory for the item. -
SupplierOnHandId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier on-hand quantity. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. This supplier site holds the on-hand inventory for the item. It's a primary key that the application generates when it creates the supplier site. -
SupplierSiteName: string
Name of the supplier site that holds the on-hand inventory for the item.
-
UnitOfMeasure: string
Unit of measure for the item.
-
UOMCode: string
Abbreviation that identifies the unit of measure for the item.
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 quantities.
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/collaborationSupplierOnHandQuantities"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "SupplierOnHandId": 7127, "SupplierId": 100000012050091, "SupplierName": "CV_SuppD01", "SupplierSiteId": 100000012050114, "SupplierSiteName": "CV_SuppD01Site1", "InventoryItemId": 300100092864032, "PlanningItemId": 734219, "CollaborationItemId": 2039, "ItemNumber": "SCC-CNTRDL-01", "SupplierItemNumber": "SCC-Supplier-CNTRDL-1", "Quantity": 500, "UOMCode": "Ea", "UnitOfMeasure": "Each", "BaseQuantity": 500, "BaseUOMCode": "Ea", "BaseUnitOfMeasure": "Each", "ProcurementBUId": 204, "ProcurementBUName": "Vision Operations", "PublishedDate": "2019-11-06T16:15:45.274+00:00", "PublishedBy": null, "PublishSourceCode": "ENTERPRISE_VAL", "PublishSource": "Enterprise", "CreatedBy": "PLANNER", "CreationDate": "2019-11-04T17:23:33+00:00", "LastUpdatedBy": "951C72132DC84471E053D48DF50A43FD", "LastUpdateDate": "2019-11-06T16:14:56+00:00", "links": [ { ... }, { ... } ] }, { "SupplierOnHandId": 3002, "SupplierId": 295, "SupplierName": "CV_SuppB09", "SupplierSiteId": 1318, "SupplierSiteName": "CVSuppB09Site01", "InventoryItemId": 300100092864032, "PlanningItemId": 734219, "CollaborationItemId": 2039, "ItemNumber": "SCC-CNTRDL-01", "SupplierItemNumber": null, "Quantity": 9000, "UOMCode": "Ea", "UnitOfMeasure": "Each", "BaseQuantity": 9000, "BaseUOMCode": "Ea", "BaseUnitOfMeasure": "Each", "ProcurementBUId": 204, "ProcurementBUName": "Vision Operations", "PublishedDate": "2019-10-30T19:52:10+00:00", "PublishedBy": "PLANNER, PLANNER", "PublishSourceCode": "ENTERPRISE_VAL", "PublishSource": "Enterprise", "CreatedBy": "PLANNER", "CreationDate": "2019-10-30T17:23:33+00:00", "LastUpdatedBy": "19F053DF5CCDC3B20BEC32083E49BE4F", "LastUpdateDate": "2019-10-30T19:52:55+00:00", "links": [ { ... }, { ... } ] }, { "SupplierOnHandId": 3006, "SupplierId": 100000012050255, "SupplierName": "CV_SuppD05", "SupplierSiteId": 300100090186604, "SupplierSiteName": "CV_SuppD05Site3", "InventoryItemId": 300100092864713, "PlanningItemId": 734251, "CollaborationItemId": 2042, "ItemNumber": "SCC-MEMDL370-01", "SupplierItemNumber": "SCC-Supplier-MEMDL370-1", "Quantity": 100, "UOMCode": "Ea", "UnitOfMeasure": "Each", "BaseQuantity": 100, "BaseUOMCode": "Ea", "BaseUnitOfMeasure": "Each", "ProcurementBUId": 204, "ProcurementBUName": "Vision Operations", "PublishedDate": "2019-11-05T06:44:33+00:00", "PublishedBy": "PLANNER, PLANNER", "PublishSourceCode": "ENTERPRISE_VAL", "PublishSource": "Enterprise", "CreatedBy": "PLANNER", "CreationDate": "2019-10-30T19:11:58+00:00", "LastUpdatedBy": "19F053DF5CCDC3B20BEC32083E49BE4F", "LastUpdateDate": "2019-11-05T06:45:32+00:00", "links": [ { ... }, { ... } ] } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { ... } ] }