Get one subinventory

get

/fscmRestApi/resources/11.13.18.05/activeSubinventories/{activeSubinventoriesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- SecondaryInventoryName and OrganizationId ---for the Active Subinventories resource and used to uniquely identify an instance of Active Subinventories. The client should not generate the hash key value. Instead, the client should query on the Active Subinventories collection resource with a filter on the primary key values in order to navigate to a specific instance of Active Subinventories.

    For example: activeSubinventories?q=SecondaryInventoryName=<value1>;OrganizationId=<value2>
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : activeSubinventories-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: Yes or No. If Yes, then the warehouse can reserve the inventory in the subinventory. If No, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: Yes or No. If Yes, then consider the inventory in the subinventory as assets. If No, then do not consider the inventory in the subinventory as assets.
  • Read Only: true
    Abbreviation that determines whether or not to consider the inventory in the subinventory as assets. Contains one of the following values: 1 or 2. If 1, then consider the inventory in the subinventory as assets. If 2, then do not consider the inventory in the subinventory as assets. The default value is 1.
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: Yes or No. If Yes, then the inventory in the subinventory is depreciable. If No, then the inventory in the subinventory is not depreciable.
  • Read Only: true
    Abbreviation that determines whether or not the inventory in the subinventory is depreciable. Contains one of the following values: 1 or 2. If 1, then the inventory in the subinventory is depreciable. If 2, then the inventory in the subinventory is not depreciable. The default value is 2.
  • Read Only: true
    Maximum Length: 50
    Description of the subinventory.
  • Read Only: true
    Date when the subinventory is disabled.
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: Yes or No. If Yes, then include inventory in the available to promise calculation. If No, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
  • Read Only: true
    Abbreviation that determines whether or not to include the inventory when calculating the inventory that is available to promise. Contains one of the following values: 1 or 2. If 1, then include inventory in the available to promise calculation. If 2, then do not include inventory in the available to promise calculation. There is no default value for this attribute.
  • Links
  • Read Only: true
    Value that uniquely identifies the location.
  • Read Only: true
    Maximum Length: 240
    Name of the location.
  • Read Only: true
    Maximum Length: 80
    Type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of stock locator control that the subinventory uses. A list of accepted values is defined in the lookup type INV_SUB_LOCATOR_CONTROL. The default value is 1.
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not the inventory is nettable. Contains one of the following values: Yes or No. If Yes, then inventory is nettable. If No, then inventory is not nettable. There is no default value for this attribute.
  • Read Only: true
    Abbreviation that determines whether or not the inventory is nettable. Contains one of the following values: 1 or 2. If 1, then inventory is nettable. If 2, then inventory is not nettable. There is no default value for this attribute.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization.
  • Read Only: true
    Value that uniquely identifies the organization.
  • Read Only: true
    Maximum Length: 240
    Name of the organization.
  • Read Only: true
    Sequence to use when picking the item from this subinventory.
  • Read Only: true
    Postprocessing lead time to use when sourcing the item.
  • Read Only: true
    Preprocessing lead time to use when sourcing the item.
  • Read Only: true
    Processing lead time to use when sourcing the item.
  • Read Only: true
    Maximum Length: 80
    Value that determines whether or not to track the on-hand quantity for the item in the subinventory. Contains one of the following values: Yes or No. If Yes, then track the on-hand quantity for the item in the subinventory. If No, then do not track the on-hand quantity for the item in the subinventory.
  • Read Only: true
    Abbreviation that determines whether or not the warehouse tracks the on-hand quantity for the item in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse tracks the on-hand quantity for the item in the subinventory. If 2, then the warehouse does not track the on-hand quantity for the item in the subinventory. The default value is 1.
  • Read Only: true
    Abbreviation that determines whether or not the warehouse can reserve the inventory in the subinventory. Contains one of the following values: 1 or 2. If 1, then the warehouse can reserve the inventory in the subinventory. If 2, then the warehouse cannot reserve the inventory in the subinventory. There is no default value for this attribute.
  • Read Only: true
    Maximum Length: 10
    Name of the subinventory.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization to use when sourcing the item.
  • Read Only: true
    Value that uniquely identifies the organization to use when sourcing the item.
  • Read Only: true
    Maximum Length: 240
    Name of the organization to use when sourcing the item.
  • Read Only: true
    Maximum Length: 10
    Subinventory to use when sourcing the item.
  • Read Only: true
    Maximum Length: 80
    Sourcing type to use when replenishing the item in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the sourcing type to use for replenishment in the subinventory. A list of accepted values is defined in the lookup type INV_SOURCE_TYPES. The default value is 2.
  • Read Only: true
    Maximum Length: 80
    Name of the status.
  • Read Only: true
    Value that uniquely identifies the status.
  • Read Only: true
    Value that uniquely identifies the subinventory.
  • Read Only: true
    Maximum Length: 80
    Value that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of subinventory. A list of accepted values is defined in the lookup type INV_SUB_TYPE. There is no default value for this attribute.
Back to Top

Examples

This example describes how to get one active 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/activeSubinvenories?onlyData=true&q=SecondaryInventoryName=value"

For example, the following command gets active subinventory Consumable in the Tall Manufacturing organization:

curl -u username:password "https://servername/fscmRestApi/resources/version/activeSubinvenories?onlyData=true&q=SecondaryInventoryName=Consumable & OrganizationName=Tall Manufacturing"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "items" : [ {
    "SubinventoryId" : 4727,
    "SecondaryInventoryName" : "Consumable",
    "OrganizationId" : 207,
    "OrganizationCode" : "M1",
    "OrganizationName" : "Tall Manufacturing\t\t",
    "Description" : "Consumables Inventory",
    "DisableDate" : null,
    "InventoryATPCode" : 1,
    "IncludeInATP" : "Yes",
    "NettableCode" : 1,
    "Nettable" : "Yes",
    "ReservableType" : 1,
    "AllowReservations" : "Yes",
    "LocatorTypeCode" : "1",
    "LocatorType" : "None",
    "PickingOrder" : 4,
    "QuantityTrackedCode" : 2,
    "QuantityTracked" : "No",
    "AssetInventoryCode" : 2,
    "AssetInventory" : "No",
    "SourceTypeCode" : "2",
    "SourceType" : "Supplier",
    "SourceSubinventory" : null,
    "SourceOrganizationId" : null,
    "SourceOrganizationCode" : null,
    "SourceOrganizationName" : null,
    "PreprocessingLeadTime" : null,
    "ProcessingLeadTime" : null,
    "PostprocessingLeadTime" : null,
    "LocationId" : null,
    "LocationName" : null,
    "DepreciableCode" : 2,
    "Depreciable" : "No",
    "StatusId" : 1,
    "StatusCode" : "Active",
    "SubinventoryTypeCode" : null,
    "SubinventoryType" : "Storage"
  } ],
  "count" : 1,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/logisticsApi/resources/version/activeSubinventories",
    "name" : "activeSubinventories",
    "kind" : "collection"
  } ]
}
Back to Top