Jump to

• Request
• Response

Get one planning remaining shelf life rule

get

/fscmRestApi/resources/11.13.18.05/remainingShelfLifeRules/{MRSLRuleId}

Request

Path Parameters

• MRSLRuleId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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: string
  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: string
  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

• 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.

Body ()

Root Schema : remainingShelfLifeRules-item-response

Type: object

Show Source

• Catalog: string
  Read Only: true

  Maximum Length: 255

  Name of the item category set or catalog in the planning remaining shelf life rule.
• CategorySetId: integer
  Read Only: true

  Value that uniquely identifies the category set or catalog in a planning remaining shelf life rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning remaining shelf life rule.
• CreationDate: string (date-time)
  Read Only: true

  Date when the planning remaining shelf life rule was created.
• DemandAnchorDateType: integer
  Read Only: true

  Type of anchor date for the remaining shelf life days. This can be Ship or Arrival. The default value is Arrival.
• Description: string
  Read Only: true

  Maximum Length: 300

  Description of the planning remaining shelf life rule.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the planning remaining shelf life rule was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the planning remaining shelf life rule.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login details used when the planning remaining shelf life rule was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MRSLRuleId: integer
  Read Only: true

  Value that uniquely identifies the planning remaining shelf life rule.
• MRSLRuleName: string
  Read Only: true

  Maximum Length: 30

  Name of the planning remaining shelf life rule.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Value that uniquely identifies the changes made to the planning remaining shelf life rule.
• RefreshNumber: number
  Read Only: true

  Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule.
• ViewRemainingShelfLife: array Planning Remaining Shelf Life Rule Details
  Title: Planning Remaining Shelf Life Rule Details

  Details for planning remaining shelf life rule.

{
    "type":"object",
    "properties":{
        "Catalog":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item category set or catalog in the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set or catalog in a planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the planning remaining shelf life rule was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandAnchorDateType":{
            "type":"integer",
            "description":"Type of anchor date for the remaining shelf life days. This can be Ship or Arrival. The default value is Arrival.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"Description of the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the planning remaining shelf life rule was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login details used when the planning remaining shelf life rule was most recently updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MRSLRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MRSLRuleName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the changes made to the planning remaining shelf life rule.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"number",
            "description":"Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewRemainingShelfLife":{
            "title":"Planning Remaining Shelf Life Rule Details",
            "type":"array",
            "description":"Details for planning remaining shelf life rule.",
            "items":{
                "$ref":"#/components/schemas/remainingShelfLifeRules-ViewRemainingShelfLife-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object remainingShelfLifeRules-ViewRemainingShelfLife-item-response

{
    "title":"Planning Remaining Shelf Life Rule Details",
    "type":"array",
    "description":"Details for planning remaining shelf life rule.",
    "items":{
        "$ref":"#/components/schemas/remainingShelfLifeRules-ViewRemainingShelfLife-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : remainingShelfLifeRules-ViewRemainingShelfLife-item-response

Type: object

Show Source

• AssignmentLevel: string
  Read Only: true

  Value that identifies the assignment level in a planning remaining shelf life rule detail.
• AssignmentType: integer
  Read Only: true

  Type of assignment level in a planning remaining shelf life rule detail.
• Category: string
  Read Only: true

  Name of the category in a planning remaining shelf life rule detail.
• CategoryId: integer
  Read Only: true

  Value that uniquely identifies the category in a planning remaining shelf life rule detail.
• CreatedBy: string
  Read Only: true

  User who created the planning remaining shelf life rule detail.
• CreationDate: string (date-time)
  Read Only: true

  Date when the planning remaining shelf life rule detail was created.
• Customer: string
  Read Only: true

  Name of the customer in a planning remaining shelf life rule detail.
• CustomerId: integer
  Read Only: true

  Value that uniquely identifies the customer in a planning remaining shelf life rule detail.
• CustomerSite: string
  Read Only: true

  Name of the customer site in a planning remaining shelf life rule detail.
• CustomerSiteId: integer
  Read Only: true

  Value that uniquely identifies the customer site in a planning remaining shelf life rule detail.
• DemandClass: string
  Read Only: true

  Name of the demand class in a planning remaining shelf life rule detail.
• DemandClassCode: string
  Read Only: true

  Demand class code that uniquely identifies the demand class in a planning remaining shelf life rule detail.
• Geography: string
  Read Only: true

  Name of the geography in a planning remaining shelf life rule detail.
• InventoryItemId: integer
  Read Only: true

  Value that uniquely identifies the geography in a planning remaining shelf life rule detail.
• Item: string
  Read Only: true

  Value that uniquely identifies the item in a planning remaining shelf life rule detail.
• LastUpdateDate: string (date-time)
  Read Only: true

  Name of the item in a planning remaining shelf life rule detail.
• LastUpdatedBy: string
  Read Only: true

  Login details used when the planning remaining shelf life rule detail was most recently updated.
• LastUpdateLogin: string
  Read Only: true

  Date when the planning remaining shelf life rule detail was most recently updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MRSLDays: integer
  Read Only: true

  User who most recently updated the planning remaining shelf life rule detail.
• MRSLRuleDetailId: integer
  Read Only: true

  Value that represents the remaining shelf life days in a planning remaining shelf life rule detail.
• MRSLRuleId: integer
  Read Only: true

  Value that uniquely identifies the planning remaining shelf life rule detail.
• Organization: string
  Read Only: true

  Value that uniquely identifies the planning remaining shelf life rule.
• OrganizationId: integer
  Read Only: true

  Name of the organization code in a planning remaining shelf life rule detail.
• Rank: integer
  Read Only: true

  Value that uniquely identifies the organization code in a planning remaining shelf life rule detail.
• RefreshNumber: integer
  Read Only: true

  Value that uniquely represents the rank of a planning remaining shelf life rule detail.
• RegionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule detail.
• Zone: string
  Read Only: true

  Value that uniquely identifies the region or geography in a planning remaining shelf life rule detail.
• ZoneId: integer
  Read Only: true

  Name of the zone in a planning remaining shelf life rule detail.

{
    "type":"object",
    "properties":{
        "AssignmentLevel":{
            "type":"string",
            "description":"Value that identifies the assignment level in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "type":"integer",
            "description":"Type of assignment level in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"Name of the category in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "type":"string",
            "description":"User who created the planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the planning remaining shelf life rule detail was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "type":"string",
            "description":"Name of the customer in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "type":"string",
            "description":"Name of the customer site in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "type":"string",
            "description":"Name of the demand class in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClassCode":{
            "type":"string",
            "description":"Demand class code that uniquely identifies the demand class in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Geography":{
            "type":"string",
            "description":"Name of the geography in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the geography in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Value that uniquely identifies the item in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Name of the item in a planning remaining shelf life rule detail.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "type":"string",
            "description":"Date when the planning remaining shelf life rule detail was most recently updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "type":"string",
            "description":"Login details used when the planning remaining shelf life rule detail was most recently updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MRSLDays":{
            "type":"integer",
            "description":"User who most recently updated the planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MRSLRuleDetailId":{
            "type":"integer",
            "description":"Value that represents the remaining shelf life days in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MRSLRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "type":"string",
            "description":"Value that uniquely identifies the planning remaining shelf life rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Name of the organization code in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization code in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RefreshNumber":{
            "type":"integer",
            "description":"Value that uniquely represents the rank of a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RegionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data collection refresh reference for the planning remaining shelf life rule detail.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Zone":{
            "type":"string",
            "description":"Value that uniquely identifies the region or geography in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ZoneId":{
            "type":"integer",
            "description":"Name of the zone in a planning remaining shelf life rule detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ViewRemainingShelfLife

Operation: /fscmRestApi/resources/11.13.18.05/remainingShelfLifeRules/{MRSLRuleId}/child/ViewRemainingShelfLife

Parameters:

• MRSLRuleId: $request.path.MRSLRuleId

Details for planning remaining shelf life rule.

Back to Top