Get all advanced inventory parameters

get

/fscmRestApi/resources/11.13.18.05/advancedInventoryParameters

Request

Query Parameters
  • 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
  • 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 Finds the advanced inventory parameter with the specified primary key.
      Finder Variables
      • OrganizationId; integer; Unique identifier of the advanced inventory parameter.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CountriesOfOriginComminglingAllowedFlag; boolean; The Advanced Inventory Parameters resource manages the advanced inventory parameters in Oracle Inventory Management Cloud application pages.
    • CrossDockDemandDueDays; integer; Indicates the demand selection due date days for cross docking.
    • CrossDockDueDateSort; string; Indicates the sort order code for the selected demands.
    • CrossDockEnabledFlag; boolean; Indicates whether cross docking is enabled.
    • CrossDockIncludeBackordersFlag; boolean; Indicates whether backorders should be included in demand selection for cross docking.
    • CrossDockItemCategoryId; integer; Indicates the ID of the item category that's eligible for cross-docking.
    • LPNEnabledFlag; boolean; Indicates whether the organization is enabled for license plate transactions.
    • LPNPrefix; string; Indicates the prefix to use while generating the license plate numbers.
    • LPNSuffix; string; Indicates the suffix to use while generating the license plate numbers.
    • LPNUCC128SuffixFlag; boolean; Indicates whether UCC-128 suffix should be appended to the license plate number.
    • NextAutoLPNNumber; string; Indicates the next available license plate number at the organization level.
    • OrganizationCode; string; Code of the inventory organization.
    • OrganizationId; integer; Identifies the inventory organization.
    • OrganizationName; string; Name of the inventory organization.
    • OutboundLoadCreationAllowedFlag; boolean; The Advanced Inventory Parameters resource manages the advanced inventory parameters in Oracle Inventory Management Cloud application pages.
    • PhysicalInvCountingMode; string; Get one inventory organization
    • ProjectsComminglingAllowedFlag; boolean; The Advanced Inventory Parameters resource manages the advanced inventory parameters in Oracle Inventory Management Cloud application pages.
    • PutAwaySuggestionPriorityFour; string; Indicates the fourth priority rule code for put away suggestions.
    • PutAwaySuggestionPriorityOne; string; Indicates the first priority rule code for put away suggestions.
    • PutAwaySuggestionPriorityThree; string; Indicates the third priority rule code for put away suggestions.
    • PutAwaySuggestionPriorityTwo; string; Indicates the second priority rule code for put away suggestions.
    • PutAwaySuggestionsEnabledFlag; boolean; Indicates whether put away suggestions are enabled.
    • StartAutoLPNNumber; string; Indicates the starting license plate number at the organization level.
    • TaskManagementAllowedFlag; boolean; The Advanced Inventory Parameters resource manages the advanced inventory parameters in Oracle Inventory Management Cloud application pages.
    • TasksComminglingAllowedFlag; boolean; The Advanced Inventory Parameters resource manages the advanced inventory parameters in Oracle Inventory Management Cloud application pages.
    • TotalLPNLength; integer; Indicates the total length required for a license plate number.
  • 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
  • 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 : advancedInventoryParameters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : advancedInventoryParameters-item-response
Type: object
Show Source
Nested Schema : InvAdvancedInvParamsDFF
Type: array
Show Source
Nested Schema : advancedInventoryParameters-InvAdvancedInvParamsDFF-item-response
Type: object
Show Source
Back to Top