Get one detail
get
/fscmRestApi/resources/11.13.18.05/onhandQuantityDetails/{onhandQuantityDetailsUniqID}
Request
Path Parameters
-
onhandQuantityDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId, InventoryItemId, SubinventoryCode, LocatorId, LotNumber and SerialNumber ---for the On-hand Quantity Details resource and used to uniquely identify an instance of On-hand Quantity Details. The client should not generate the hash key value. Instead, the client should query on the On-hand Quantity Details collection resource with a filter on the primary key values in order to navigate to a specific instance of On-hand Quantity Details.
For example: onhandQuantityDetails?q=OrganizationId=<value1>;InventoryItemId=<value2>;SubinventoryCode=<value3>;LocatorId=<value4>;LotNumber=<value5>;SerialNumber=<value6>
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : onhandQuantityDetails-item-response
Type:
Show Source
object
-
ConsignedQuantity: number
Read Only:
true
Consigned quantity for the item. -
ConsignedQuantityDetails: array
Consigned Quantity Details
Title:
Consigned Quantity Details
The Consigned Quantity Details resource uses information about the item and inventory location that you provide to get details about the consigned quantities in the primary UOM or secondary UOM. -
InboundQuantity: number
Read Only:
true
Inbound quantity for the item. -
InboundQuantityDetails: array
Inbound Quantity Details
Title:
Inbound Quantity Details
The Inbound Quantity Details resource uses information about the item and inventory location that you provide to get details about the inbound quantities in the primary UOM or secondary UOM. -
InventoryItemId: integer
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:255
Name of the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocatorId: integer
Read Only:
true
Value that uniquely identifies the locator. -
LotNumber: string
Read Only:
true
Maximum Length:255
Lot number of the inventory item. -
OnhandQuantity: number
Read Only:
true
On-hand quantity for the item. -
OrganizationCode: string
Read Only:
true
Maximum Length:255
Name of the organization. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization. -
OwningOrganization: string
Read Only:
true
Maximum Length:255
Name of the owning organization. -
OwningOrganizationId: integer
Read Only:
true
Value that uniquely identifies the owning party. -
PrimaryUOMCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the primary unit of measure. -
ReceivingQuantity: number
Read Only:
true
Receiving quantity for the item. -
ReservedQuantity: number
Read Only:
true
Reserved quantity for the item. -
SecondaryConsignedQuantity: number
Read Only:
true
Secondary consigned quantity for the item. -
SecondaryInboundQuantity: number
Read Only:
true
Secondary inbound quantity for the item. -
SecondaryOnhandQuantity: integer
(int64)
Read Only:
true
Secondary on-hand quantity for the item. -
SecondaryReceivingQuantity: number
Read Only:
true
Secondary receiving quantity for the item. -
SecondaryReservedQuantity: number
Read Only:
true
Secondary reserved quantity for the item. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the secondary unit of measure. -
SerialNumber: string
Read Only:
true
Maximum Length:255
Serial number of the item. -
SubinventoryCode: string
Read Only:
true
Maximum Length:255
Name of the subinventory.
Nested Schema : Consigned Quantity Details
Type:
array
Title:
Consigned Quantity Details
The Consigned Quantity Details resource uses information about the item and inventory location that you provide to get details about the consigned quantities in the primary UOM or secondary UOM.
Show Source
Nested Schema : Inbound Quantity Details
Type:
array
Title:
Inbound Quantity Details
The Inbound Quantity Details resource uses information about the item and inventory location that you provide to get details about the inbound quantities in the primary UOM or secondary UOM.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : onhandQuantityDetails-ConsignedQuantityDetails-item-response
Type:
Show Source
object
-
ConsignedQuantity: number
Read Only:
true
Consigned quantity for the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyName: string
Read Only:
true
Maximum Length:360
Name of the owning party. -
PartyNumber: string
Read Only:
true
Maximum Length:30
Name of the owning party. -
PartyType: string
Read Only:
true
Maximum Length:30
Value that indicates the type of owning party. Valid values are Person, Organization, or Group. -
SecondaryConsignedQuantity: number
Read Only:
true
Secondary consigned quantity 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.
Nested Schema : onhandQuantityDetails-InboundQuantityDetails-item-response
Type:
Show Source
object
-
DocumentNumber: string
Read Only:
true
Maximum Length:30
Document number that identifies the inbound shipment. -
DocumentType: string
Read Only:
true
Type of document. -
InboundQuantity: number
Read Only:
true
Inbound quantity for the item. -
LineNumber: number
Read Only:
true
Value that identifies the line number for the inbound shipment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Schedule: string
Read Only:
true
Schedule for the shipment. -
SecondaryInboundQuantity: number
Read Only:
true
Secondary inbound quantity for the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ConsignedQuantityDetails
-
Parameters:
- onhandQuantityDetailsUniqID:
$request.path.onhandQuantityDetailsUniqID
The Consigned Quantity Details resource uses information about the item and inventory location that you provide to get details about the consigned quantities in the primary UOM or secondary UOM. - onhandQuantityDetailsUniqID:
- InboundQuantityDetails
-
Parameters:
- onhandQuantityDetailsUniqID:
$request.path.onhandQuantityDetailsUniqID
The Inbound Quantity Details resource uses information about the item and inventory location that you provide to get details about the inbound quantities in the primary UOM or secondary UOM. - onhandQuantityDetailsUniqID:
Examples
This example describes how to get details for one on-hand quantity.
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/onhandQuantityDetails/onhandQuantityDetailsUniqID"
For example, the following command gets details for on-hand quantity 00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF:
curl -u username:password "https://servername/fscmRestApi/resources/version/onhandQuantityDetails/00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "OrganizationId": 207, "OrganizationCode": "M1", "InventoryItemId": 663997, "ItemNumber": "VC110", "SubinventoryCode": null, "LocatorId": null, "LotNumber": null, "OnhandQuantity": 110, "SecondaryOnhandQuantity": null, "ReceivingQuantity": 16, "SecondaryReceivingQuantity": null, "ReservedQuantity": null, "SecondaryReservedQuantity": null, "InboundQuantity": 2099, "SecondaryInboundQuantity": null, "ConsignedQuantity": 36, "SecondaryConsignedQuantity": null, "OwningOrganizationId": null, "OwningOrganization": null, "SerialNumber": null, "PrimaryUOMCode": "Ea", "SecondaryUOMCode": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/onhandQuantityDetails/00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "name": "onhandQuantityDetails", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/onhandQuantityDetails/00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "name": "onhandQuantityDetails", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/onhandQuantityDetails/00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/ConsignedQuantityDetails", "name": "ConsignedQuantityDetails", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/onhandQuantityDetails/00060000000EACED0005770800000000000000CF0000000EACED0005770800000000000A21BDFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/InboundQuantityDetails", "name": "InboundQuantityDetails", "kind": "collection" } ] }