Get one subinventory
get
/fscmRestApi/resources/11.13.18.05/subinventories/{subinventoriesUniqID}/child/itemSubinventories/{itemSubinventoriesUniqID}
Request
Path Parameters
-
itemSubinventoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Item Subinventories resource and used to uniquely identify an instance of Item Subinventories. The client should not generate the hash key value. Instead, the client should query on the Item Subinventories collection resource in order to navigate to a specific instance of Item Subinventories to get the hash key.
-
subinventoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OrganizationId and SecondaryInventoryName ---for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Subinventories.
For example: subinventories?q=OrganizationId=<value1>;SecondaryInventoryName=<value2>
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 : subinventories-itemSubinventories-item-response
Type:
Show Source
object-
CountRequired: string
Title:
Count RequiredMaximum Length:1Contains the values 1 or 2. 1: The application requires counting during periodic-automatic replenishment for the item in the locator. 2: The application doesn't require this counting. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the item subinventory record. -
DefaultCountType: string
Maximum Length:
255Type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is Order par. -
DefaultCountTypeCode: string
Title:
Replenishment Count TypeMaximum Length:30Abbreviation that identifies the type of periodic automatic replenishment. A list of accepted values is defined in the lookup type INV_DEFAULT_REPLEN_COUNT_TYPE. The default value is 4. -
FixedLotMultiple: integer
(int32)
Title:
Fixed Lot MultipleValue of the fixed lot multiple. Used while sourcing the material for the item. You can source an item only in this value. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Value that identifies the description of the item associated with a subinventory. -
ItemNumber: string
Maximum Length:
300Name that identifies the product or material in the subinventory. -
ItemPrimaryImageURL: string
Title:
Primary Image URLRead Only:trueMaximum Length:4000Value that provides a reference to the image of the item for which the count sequence is generated. -
itemSubinventoriesDFF: array
Flexfields
Title:
FlexfieldsThe Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories. -
LastReplenishedDate: string
(date-time)
Date when the item was last replenished for a subinventory during par counting.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumMinmaxQuantity: number
Title:
Maximum QuantityMaximum quantity for min-max replenishment. -
MaximumOrderQuantity: number
Title:
Maximum Order QuantityMaximum order quantity for replenishment. -
MinimumMaximumPlanningCode: integer
(int32)
Title:
Inventory Planning MethodDefault Value:6Abbreviation that determines whether to enable min-max planning for the item subinventory. A list of accepted values is defined in the lookup type INV_MATERIAL_PLANNING. -
MinimumMaximumPlanningMeaning: string
Maximum Length:
255Value used to determine whether to enable min-max planning for an item subinventory. -
MinimumMinmaxQuantity: number
Title:
Minimum QuantityMinimum quantity for min-max replenishment. -
MinimumOrderQuantity: number
Title:
Minimum Order QuantityMinimum order quantity for replenishment. -
MinmaxQuantityUOM: string
Maximum Length:
3Abbreviation that identifies the unit of measure to use for the min-max quantities. -
MinmaxQuantityUOMMeasure: string
Maximum Length:
255Unit of measure to use for the min-max quantities. -
ParLevel: number
Title:
PAR LevelLevel that the application uses for the item subinventory during periodic automatic replenishment. -
ParMaximumQuantity: number
Title:
PAR Maximum QuantityMaximum quantity to use during periodic automatic replenishment. -
ParUOMCode: string
Title:
PAR Level UOMMaximum Length:3Abbreviation that identifies the unit of measure to use for quantities during periodic automatic replenishment. -
ParUOMMeasure: string
Title:
PAR Level UOMUnit of measure to use for quantities during periodic automatic replenishment. -
PostprocessingLeadTime: integer
Title:
PostprocessingPost processing lead time to use while sourcing the item. -
PreprocessingLeadTime: integer
Title:
PreprocessingPreprocessing lead time to use while sourcing the item. -
ProcessingLeadTime: integer
Title:
ProcessingProcessing lead time to use while sourcing the item. -
QuantityCountTolerance: number
Title:
Count Tolerance PercentageCount tolerance percent to use before the application doesn't allow the count. This tolerance prevents data entry mistakes when counting, and prevents ordering too much quantity for the replenishment request. -
SecondaryInventory: string
Maximum Length:
10Subinventory that references the item. -
SourceOrderingUOM: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the unit of measure to use for sourcing. -
SourceOrderingUOMMeasure: string
Maximum Length:
255Unit of measure to use for sourcing. -
SourceOrganizationCode: string
Maximum Length:
255Abbreviation that identifies the source organization. Used while sourcing the material for the item to this subinventory. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization. Used while sourcing the material for the item to this subinventory.
-
SourceOrganizationName: string
Read Only:
trueMaximum Length:255Name of the source organization. This organization is used while sourcing the item for this subinventory. -
SourceSubinventory: string
Title:
Sourcing SubinventoryMaximum Length:10Name of the source subinventory. Used while sourcing the material for the item to this subinventory. -
SourceType: string
Title:
Sourcing TypeMaximum Length:30Sourcing type to use to replenish stock for the item to this subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 6. -
SourceTypeMeaning: string
Maximum Length:
255Value of the sourcing type used to specify the location from which the stock for the item is replenished into the subinventory.
Nested Schema : Flexfields
Type:
arrayTitle:
FlexfieldsThe Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : subinventories-itemSubinventories-itemSubinventoriesDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30Context value of the item subinventory that the descriptive flexfield references. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueDisplay value of the item subinventory that the descriptive flexfield references. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
SecondaryInventory: string
Maximum Length:
10Name of the subinventory.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- itemSubinventoriesDFF
-
Parameters:
- itemSubinventoriesUniqID:
$request.path.itemSubinventoriesUniqID - subinventoriesUniqID:
$request.path.subinventoriesUniqID
The Flexfields for Item Subinventories resource manages descriptive flexfields that contain details about item subinventories. - itemSubinventoriesUniqID:
Examples
This example describes how to get one item subinventory in one subinventory.
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/subinventories/subinventoriesUniqID/itemSubinventories/child/itemSubinventories/itemSubinventoriesUniqID"
For example, the following command gets item subinventory 00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031 in subinventory 00020000000EACED0005770800000000000000CF000000084142435355423031:
curl -u username:password "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/itemSubinventories/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031"
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"FixedLotMultiple": null,
"InventoryItemId": 663907,
"MinimumMaximumPlanningCode": 6,
"MaximumMinmaxQuantity": null,
"MaximumOrderQuantity": null,
"MinimumMinmaxQuantity": null,
"MinimumOrderQuantity": null,
"PostprocessingLeadTime": null,
"PreprocessingLeadTime": null,
"ProcessingLeadTime": null,
"SecondaryInventory": "ABCSUB01",
"SourceOrganizationId": null,
"SourceSubinventory": null,
"SourceType": null,
"ItemNumber": "RCV-100",
"SourceOrganizationCode": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031",
"name": "itemSubinventories",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031",
"name": "itemSubinventories",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031",
"name": "subinventories",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031/lov/SourceTypeLov",
"name": "SourceTypeLov",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031/lov/MinMaxPlanningLov",
"name": "MinMaxPlanningLov",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/subinventories/00020000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventories/00030000000EACED0005770800000000000A21630000000EACED0005770800000000000000CF000000084142435355423031/child/itemSubinventoriesDFF",
"name": "itemSubinventoriesDFF",
"kind": "collection"
}
]
}