Get all planning remaining shelf life rules

get

/fscmRestApi/resources/11.13.18.05/remainingShelfLifeRules

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 planning remaining shelf life rule based on the value that uniquely identifies the rule.
      Finder Variables
      • MRSLRuleId; integer; Value that uniquely identifies the planning remaining shelf life rule associated with the rule name.
  • 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:
    • Catalog; string; Name of the item category set or catalog in the planning remaining shelf life rule.
    • CategorySetId; integer; Value that uniquely identifies the category set or catalog in a planning remaining shelf life rule.
    • CreatedBy; string; User who created the planning remaining shelf life rule.
    • CreationDate; string; Date when the planning remaining shelf life rule was created.
    • DemandAnchorDateType; integer; Type of anchor date for the remaining shelf life days. This can be Ship or Arrival. The default value is Arrival.
    • Description; string; Description of the planning remaining shelf life rule.
    • LastUpdateDate; string; Date when the planning remaining shelf life rule was most recently updated.
    • LastUpdateLogin; string; Login details used when the planning remaining shelf life rule was most recently updated.
    • LastUpdatedBy; string; User who most recently updated the planning remaining shelf life rule.
    • MRSLRuleId; integer; Value that uniquely identifies the planning remaining shelf life rule.
    • MRSLRuleName; string; Name of the planning remaining shelf life rule.
    • ObjectVersionNumber; integer; Value that uniquely identifies the changes made to the planning remaining shelf life rule.
    • RefreshNumber; number; Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule.
  • 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 : remainingShelfLifeRules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : remainingShelfLifeRules-item-response
Type: object
Show Source
Nested Schema : Planning Remaining Shelf Life Rule Details
Type: array
Title: Planning Remaining Shelf Life Rule Details
Details for planning remaining shelf life rule.
Show Source
Nested Schema : remainingShelfLifeRules-ViewRemainingShelfLife-item-response
Type: object
Show Source
  • Read Only: true
    Value that identifies the assignment level in a planning remaining shelf life rule detail.
  • Read Only: true
    Type of assignment level in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the category in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the category in a planning remaining shelf life rule detail.
  • Read Only: true
    User who created the planning remaining shelf life rule detail.
  • Read Only: true
    Date when the planning remaining shelf life rule detail was created.
  • Read Only: true
    Name of the customer in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the customer in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the customer site in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the customer site in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the demand class in a planning remaining shelf life rule detail.
  • Read Only: true
    Demand class code that uniquely identifies the demand class in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the geography in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the geography in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the item in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the item in a planning remaining shelf life rule detail.
  • Read Only: true
    Login details used when the planning remaining shelf life rule detail was most recently updated.
  • Read Only: true
    Date when the planning remaining shelf life rule detail was most recently updated.
  • Links
  • Read Only: true
    User who most recently updated the planning remaining shelf life rule detail.
  • Read Only: true
    Value that represents the remaining shelf life days in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the planning remaining shelf life rule.
  • Read Only: true
    Name of the organization code in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the organization code in a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely represents the rank of a planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule detail.
  • Read Only: true
    Value that uniquely identifies the region or geography in a planning remaining shelf life rule detail.
  • Read Only: true
    Name of the zone in a planning remaining shelf life rule detail.
Back to Top