Jump to

• Request
• Response

Get all records for policy comparison

get

/fscmRestApi/resources/11.13.18.05/replenishmentPolicyComparisons

Request

Query Parameters

• 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
• finder: string
  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 policy comparison record according to the identifier.
    Finder Variables
    • InventoryItemId; integer; Finds the policy comparison record according to the item identifier.
    • OrganizationId; integer; Finds the policy comparison record according to the organization identifier.
    • PlanId; integer; Finds the policy comparison record according to the plan identifier.
    • SegmentId; integer; Finds the policy comparison record according to the segment identifier.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • AverageDailyDmdPrior; integer; Prior average daily demand value.
  • AverageDailyDmdSuggested; integer; Suggested average daily demand value.
  • CreatedBy; string; User who created the policy comparison records.
  • CreationDate; string; Date when the policy comparison records were created.
  • EoqPrior; integer; Prior economic order quantity value.
  • EoqSuggested; integer; Suggested economic order quantity value.
  • FinalMaximumDays; integer; Final maximum value in days.
  • FinalMaximumQuantity; integer; Final maximum quantity value.
  • FinalMinimumDays; integer; Final minimum value in days.
  • FinalMinimumQuantity; integer; Final minimum quantity value.
  • FinalParLevel; integer; Final par-level value.
  • FinalParMaximum; integer; Final maximum par value.
  • FinalROPDays; integer; Final reorder point value in days.
  • FinalROPQuantity; integer; Final reorder point value.
  • InventoryItemId; integer; Value that uniquely identifies the inventory item.
  • ItemName; string; Name of the item.
  • LastUpdateDate; string; Date when the user most recently updated the policy comparison records.
  • LastUpdatedBy; string; User who most recently updated the policy comparison records.
  • LocationName; string; Name of the location.
  • MaximumDays; integer; Maximum policy value in days.
  • MaximumDaysAdjusted; integer; Adjusted maximum policy value in days.
  • MaximumDaysDeviation; integer; Deviation in maximum days policy value.
  • MaximumDaysPrior; integer; Prior maximum policy value in days.
  • MaximumDaysPriorType; integer; Type of prior maximum policy value in days.
  • MaximumDaysPriorTypeName; string; Name of the type of the prior maximum days policy value.
  • MaximumDaysSuggested; integer; Suggested maximum policy value in days.
  • MaximumQuantity; integer; Maximum quantity value.
  • MaximumQuantityAdjusted; integer; Adjusted maximum quantity value.
  • MaximumQuantityDeviation; integer; Deviation in maximum quantity value.
  • MaximumQuantityPrior; integer; Prior maximum quantity value.
  • MaximumQuantityPriorType; integer; Type of prior maximum quantity value.
  • MaximumQuantityPriorTypeName; string; Name of type of the prior maximum quantity value.
  • MaximumQuantitySuggested; integer; Suggested maximum quantity value.
  • MinimumDays; integer; Minimum policy value in days.
  • MinimumDaysAdjusted; integer; Adjusted minimum policy value in days.
  • MinimumDaysDeviation; integer; Deviation in minimum days policy value.
  • MinimumDaysPrior; integer; Prior minimum policy value in days.
  • MinimumDaysPriorType; integer; Type of prior minimum policy value in days.
  • MinimumDaysPriorTypeName; string; Name of the type of the prior minimum days policy value.
  • MinimumDaysSuggested; integer; Suggested minimum policy value in days.
  • MinimumQuantity; integer; Minimum quantity value.
  • MinimumQuantityAdjusted; integer; Adjusted minimum quantity value.
  • MinimumQuantityDeviation; integer; Deviation in minimum quantity value.
  • MinimumQuantityPrior; integer; Prior minimum quantity value.
  • MinimumQuantityPriorType; integer; Type of prior minimum quantity value.
  • MinimumQuantityPriorTypeName; string; Name of the type of prior minimum quantity value.
  • MinimumQuantitySuggested; integer; Suggested minimum quantity value.
  • NotesIndicator; string; Value that indicates whether notes are present for the item.
  • OrderQuantityPrior; integer; Value of the prior order quantity.
  • OrderQuantitySuggested; integer; Suggested order quantity value.
  • OrganizationId; integer; Value that identifies the organization code.
  • ParLevel; integer; Par level value.
  • ParLevelAdjusted; integer; Adjusted par-level value.
  • ParLevelDeviation; integer; Deviation in par-level value.
  • ParLevelPrior; integer; Prior par-level value.
  • ParLevelPriorType; integer; Type of prior par-level value.
  • ParLevelPriorTypeName; string; Name of prior par-level value type.
  • ParLevelSuggested; integer; Suggested par-level value.
  • ParMaximum; integer; Par maximum value.
  • ParMaximumAdjusted; integer; Adjusted par maximum value.
  • ParMaximumDeviation; integer; Deviation in par maximum value.
  • ParMaximumPrior; integer; Prior par maximum value.
  • ParMaximumPriorType; integer; Type of prior par maximum value.
  • ParMaximumPriorTypeName; string; Name of the type of prior par maximum value.
  • ParMaximumSuggested; integer; Suggested maximum par value.
  • PlanId; integer; Value that uniquely identifies the plan.
  • PlanName; string; Unique identifier for a plan name.
  • PlannerCode; string; Abbreviation that identifies the planner responsible for the item.
  • PolicyReviewStatus; integer; Status of the policy comparison review process.
  • PolicyReviewStatusName; string; Name of the status of the policy comparison review process.
  • PolicyType; integer; Type of policy.
  • PolicyTypeName; string; Name of the type of policy.
  • PolicyUOM; integer; Unit of measure in which policies are defined or calculated.
  • PolicyUOMName; string; Name of the unit of measure in which policies are defined or calculated.
  • RopDays; integer; Reorder point value in days.
  • RopDaysAdjusted; integer; Adjusted reorder point value in days.
  • RopDaysDeviation; integer; Deviation in reorder point days value.
  • RopDaysPrior; integer; Prior reorder point value in days.
  • RopDaysPriorType; integer; Type of prior reorder point value in days.
  • RopDaysPriorTypeName; string; Name of the type of prior reorder point policy value.
  • RopDaysSuggested; integer; Suggested reorder point value in days.
  • RopQuantity; integer; Reorder point value.
  • RopQuantityAdjusted; integer; Adjusted reorder point value.
  • RopQuantityDeviation; integer; Deviation in reorder point value.
  • RopQuantityPrior; integer; Prior reorder point value.
  • RopQuantityPriorType; integer; Type of prior reorder point value.
  • RopQuantityPriorTypeName; string; Name of the type of prior reorder point value.
  • RopQuantitySuggested; integer; Suggested reorder point value.
  • SegmentId; integer; Value that uniquely identifies the segment.
  • SegmentName; string; Name of the segment.
  • SsDaysPrior; integer; Prior safety stock value in days.
  • SsDaysSuggested; integer; Suggested safety stock value in days.
  • SsQuantityPrior; integer; Prior safety stock value.
  • SsQuantitySuggested; integer; Suggested safety stock value.
  • UpdateStatus; integer; Updated status of the policy comparison row.
• totalResults: boolean
  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

• 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 : replenishmentPolicyComparisons

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPolicyComparisons-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object replenishmentPolicyComparisons-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPolicyComparisons-item-response"
    }
}

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 : replenishmentPolicyComparisons-item-response

Type: object

Show Source

• AcceptAllExecute: array Run Accept-All Processes
  Title: Run Accept-All Processes

  Acceptance of policies for selected item location combinations.
• AverageDailyDmdPrior: integer
  Prior average daily demand value.
• AverageDailyDmdSuggested: integer
  Suggested average daily demand value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the policy comparison records.
• CreationDate: string (date-time)
  Read Only: true

  Date when the policy comparison records were created.
• EoqPrior: integer
  Prior economic order quantity value.
• EoqSuggested: integer
  Suggested economic order quantity value.
• FinalMaximumDays: integer
  Final maximum value in days.
• FinalMaximumQuantity: integer
  Final maximum quantity value.
• FinalMinimumDays: integer
  Final minimum value in days.
• FinalMinimumQuantity: integer
  Final minimum quantity value.
• FinalParLevel: integer
  Final par-level value.
• FinalParMaximum: integer
  Final maximum par value.
• FinalROPDays: integer
  Final reorder point value in days.
• FinalROPQuantity: integer
  Final reorder point value.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemName: string
  Maximum Length: 255

  Name of the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the policy comparison records.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the policy comparison records.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationName: string
  Maximum Length: 255

  Name of the location.
• MaximumDays: integer
  Maximum policy value in days.
• MaximumDaysAdjusted: integer
  Adjusted maximum policy value in days.
• MaximumDaysDeviation: integer
  Deviation in maximum days policy value.
• MaximumDaysPrior: integer
  Prior maximum policy value in days.
• MaximumDaysPriorType: integer
  Type of prior maximum policy value in days.
• MaximumDaysPriorTypeName: string
  Maximum Length: 255

  Name of the type of the prior maximum days policy value.
• MaximumDaysSuggested: integer
  Suggested maximum policy value in days.
• MaximumQuantity: integer
  Maximum quantity value.
• MaximumQuantityAdjusted: integer
  Adjusted maximum quantity value.
• MaximumQuantityDeviation: integer
  Deviation in maximum quantity value.
• MaximumQuantityPrior: integer
  Prior maximum quantity value.
• MaximumQuantityPriorType: integer
  Type of prior maximum quantity value.
• MaximumQuantityPriorTypeName: string
  Maximum Length: 255

  Name of type of the prior maximum quantity value.
• MaximumQuantitySuggested: integer
  Suggested maximum quantity value.
• MinimumDays: integer
  Minimum policy value in days.
• MinimumDaysAdjusted: integer
  Adjusted minimum policy value in days.
• MinimumDaysDeviation: integer
  Deviation in minimum days policy value.
• MinimumDaysPrior: integer
  Prior minimum policy value in days.
• MinimumDaysPriorType: integer
  Type of prior minimum policy value in days.
• MinimumDaysPriorTypeName: string
  Maximum Length: 255

  Name of the type of the prior minimum days policy value.
• MinimumDaysSuggested: integer
  Suggested minimum policy value in days.
• MinimumQuantity: integer
  Minimum quantity value.
• MinimumQuantityAdjusted: integer
  Adjusted minimum quantity value.
• MinimumQuantityDeviation: integer
  Deviation in minimum quantity value.
• MinimumQuantityPrior: integer
  Prior minimum quantity value.
• MinimumQuantityPriorType: integer
  Type of prior minimum quantity value.
• MinimumQuantityPriorTypeName: string
  Maximum Length: 255

  Name of the type of prior minimum quantity value.
• MinimumQuantitySuggested: integer
  Suggested minimum quantity value.
• NotesIndicator: string
  Maximum Length: 255

  Value that indicates whether notes are present for the item.
• OrderQuantityPrior: integer
  Value of the prior order quantity.
• OrderQuantitySuggested: integer
  Suggested order quantity value.
• OrganizationId: integer (int64)
  Value that identifies the organization code.
• ParLevel: integer
  Par level value.
• ParLevelAdjusted: integer
  Adjusted par-level value.
• ParLevelDeviation: integer
  Deviation in par-level value.
• ParLevelPrior: integer
  Prior par-level value.
• ParLevelPriorType: integer
  Type of prior par-level value.
• ParLevelPriorTypeName: string
  Maximum Length: 255

  Name of prior par-level value type.
• ParLevelSuggested: integer
  Suggested par-level value.
• ParMaximum: integer
  Par maximum value.
• ParMaximumAdjusted: integer
  Adjusted par maximum value.
• ParMaximumDeviation: integer
  Deviation in par maximum value.
• ParMaximumPrior: integer
  Prior par maximum value.
• ParMaximumPriorType: integer
  Type of prior par maximum value.
• ParMaximumPriorTypeName: string
  Maximum Length: 255

  Name of the type of prior par maximum value.
• ParMaximumSuggested: integer
  Suggested maximum par value.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanName: string
  Maximum Length: 255

  Unique identifier for a plan name.
• PlannerCode: string
  Maximum Length: 255

  Abbreviation that identifies the planner responsible for the item.
• PolicyReviewStatus: integer
  Status of the policy comparison review process.
• PolicyReviewStatusName: string
  Maximum Length: 255

  Name of the status of the policy comparison review process.
• PolicyType: integer
  Type of policy.
• PolicyTypeName: string
  Maximum Length: 255

  Name of the type of policy.
• PolicyUOM: integer
  Unit of measure in which policies are defined or calculated.
• PolicyUOMName: string
  Maximum Length: 255

  Name of the unit of measure in which policies are defined or calculated.
• PublishParExecute: array Run Publish Par Processes
  Title: Run Publish Par Processes

  Publishing of par policies for selected item locations.
• RopDays: integer
  Reorder point value in days.
• RopDaysAdjusted: integer
  Adjusted reorder point value in days.
• RopDaysDeviation: integer
  Deviation in reorder point days value.
• RopDaysPrior: integer
  Prior reorder point value in days.
• RopDaysPriorType: integer
  Type of prior reorder point value in days.
• RopDaysPriorTypeName: string
  Maximum Length: 255

  Name of the type of prior reorder point policy value.
• RopDaysSuggested: integer
  Suggested reorder point value in days.
• RopQuantity: integer
  Reorder point value.
• RopQuantityAdjusted: integer
  Adjusted reorder point value.
• RopQuantityDeviation: integer
  Deviation in reorder point value.
• RopQuantityPrior: integer
  Prior reorder point value.
• RopQuantityPriorType: integer
  Type of prior reorder point value.
• RopQuantityPriorTypeName: string
  Maximum Length: 255

  Name of the type of prior reorder point value.
• RopQuantitySuggested: integer
  Suggested reorder point value.
• SegmentId: integer (int64)
  Value that uniquely identifies the segment.
• SegmentName: string
  Maximum Length: 255

  Name of the segment.
• SsDaysPrior: integer
  Prior safety stock value in days.
• SsDaysSuggested: integer
  Suggested safety stock value in days.
• SsQuantityPrior: integer
  Prior safety stock value.
• SsQuantitySuggested: integer
  Suggested safety stock value.
• UpdatePoliciesExecute: array Run Update Policies Processes
  Title: Run Update Policies Processes

  Update of policies for selected item location combinations.
• UpdateStatus: integer (int32)
  Updated status of the policy comparison row.

{
    "type":"object",
    "properties":{
        "AcceptAllExecute":{
            "title":"Run Accept-All Processes",
            "type":"array",
            "description":"Acceptance of policies for selected item location combinations.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPolicyComparisons-AcceptAllExecute-item-response"
            }
        },
        "AverageDailyDmdPrior":{
            "type":"integer",
            "description":"Prior average daily demand value.",
            "nullable":true,
            "x-queryable":true
        },
        "AverageDailyDmdSuggested":{
            "type":"integer",
            "description":"Suggested average daily demand value.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the policy comparison records.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the policy comparison records were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EoqPrior":{
            "type":"integer",
            "description":"Prior economic order quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "EoqSuggested":{
            "type":"integer",
            "description":"Suggested economic order quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalMaximumDays":{
            "type":"integer",
            "description":"Final maximum value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalMaximumQuantity":{
            "type":"integer",
            "description":"Final maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalMinimumDays":{
            "type":"integer",
            "description":"Final minimum value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalMinimumQuantity":{
            "type":"integer",
            "description":"Final minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalParLevel":{
            "type":"integer",
            "description":"Final par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalParMaximum":{
            "type":"integer",
            "description":"Final maximum par value.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalROPDays":{
            "type":"integer",
            "description":"Final reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalROPQuantity":{
            "type":"integer",
            "description":"Final reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the policy comparison records.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the policy comparison records.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDays":{
            "type":"integer",
            "description":"Maximum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysAdjusted":{
            "type":"integer",
            "description":"Adjusted maximum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysDeviation":{
            "type":"integer",
            "description":"Deviation in maximum days policy value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysPrior":{
            "type":"integer",
            "description":"Prior maximum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysPriorType":{
            "type":"integer",
            "description":"Type of prior maximum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of the prior maximum days policy value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumDaysSuggested":{
            "type":"integer",
            "description":"Suggested maximum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantity":{
            "type":"integer",
            "description":"Maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityAdjusted":{
            "type":"integer",
            "description":"Adjusted maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityDeviation":{
            "type":"integer",
            "description":"Deviation in maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityPrior":{
            "type":"integer",
            "description":"Prior maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityPriorType":{
            "type":"integer",
            "description":"Type of prior maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantityPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of type of the prior maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumQuantitySuggested":{
            "type":"integer",
            "description":"Suggested maximum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDays":{
            "type":"integer",
            "description":"Minimum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysAdjusted":{
            "type":"integer",
            "description":"Adjusted minimum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysDeviation":{
            "type":"integer",
            "description":"Deviation in minimum days policy value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysPrior":{
            "type":"integer",
            "description":"Prior minimum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysPriorType":{
            "type":"integer",
            "description":"Type of prior minimum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of the prior minimum days policy value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumDaysSuggested":{
            "type":"integer",
            "description":"Suggested minimum policy value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantity":{
            "type":"integer",
            "description":"Minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantityAdjusted":{
            "type":"integer",
            "description":"Adjusted minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantityDeviation":{
            "type":"integer",
            "description":"Deviation in minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantityPrior":{
            "type":"integer",
            "description":"Prior minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantityPriorType":{
            "type":"integer",
            "description":"Type of prior minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantityPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of prior minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumQuantitySuggested":{
            "type":"integer",
            "description":"Suggested minimum quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "NotesIndicator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates whether notes are present for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderQuantityPrior":{
            "type":"integer",
            "description":"Value of the prior order quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderQuantitySuggested":{
            "type":"integer",
            "description":"Suggested order quantity value.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that identifies the organization code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParLevel":{
            "type":"integer",
            "description":"Par level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelAdjusted":{
            "type":"integer",
            "description":"Adjusted par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelDeviation":{
            "type":"integer",
            "description":"Deviation in par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelPrior":{
            "type":"integer",
            "description":"Prior par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelPriorType":{
            "type":"integer",
            "description":"Type of prior par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of prior par-level value type.",
            "nullable":true,
            "x-queryable":true
        },
        "ParLevelSuggested":{
            "type":"integer",
            "description":"Suggested par-level value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximum":{
            "type":"integer",
            "description":"Par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumAdjusted":{
            "type":"integer",
            "description":"Adjusted par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumDeviation":{
            "type":"integer",
            "description":"Deviation in par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumPrior":{
            "type":"integer",
            "description":"Prior par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumPriorType":{
            "type":"integer",
            "description":"Type of prior par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of prior par maximum value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParMaximumSuggested":{
            "type":"integer",
            "description":"Suggested maximum par value.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier for a plan name.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannerCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the planner responsible for the item.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyReviewStatus":{
            "type":"integer",
            "description":"Status of the policy comparison review process.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyReviewStatusName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the status of the policy comparison review process.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyType":{
            "type":"integer",
            "description":"Type of policy.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of policy.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyUOM":{
            "type":"integer",
            "description":"Unit of measure in which policies are defined or calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the unit of measure in which policies are defined or calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "PublishParExecute":{
            "title":"Run Publish Par Processes",
            "type":"array",
            "description":"Publishing of par policies for selected item locations.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPolicyComparisons-PublishParExecute-item-response"
            }
        },
        "RopDays":{
            "type":"integer",
            "description":"Reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysAdjusted":{
            "type":"integer",
            "description":"Adjusted reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysDeviation":{
            "type":"integer",
            "description":"Deviation in reorder point days value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysPrior":{
            "type":"integer",
            "description":"Prior reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysPriorType":{
            "type":"integer",
            "description":"Type of prior reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of prior reorder point policy value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopDaysSuggested":{
            "type":"integer",
            "description":"Suggested reorder point value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantity":{
            "type":"integer",
            "description":"Reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantityAdjusted":{
            "type":"integer",
            "description":"Adjusted reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantityDeviation":{
            "type":"integer",
            "description":"Deviation in reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantityPrior":{
            "type":"integer",
            "description":"Prior reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantityPriorType":{
            "type":"integer",
            "description":"Type of prior reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantityPriorTypeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the type of prior reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "RopQuantitySuggested":{
            "type":"integer",
            "description":"Suggested reorder point value.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the segment.",
            "nullable":true,
            "x-queryable":true
        },
        "SsDaysPrior":{
            "type":"integer",
            "description":"Prior safety stock value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "SsDaysSuggested":{
            "type":"integer",
            "description":"Suggested safety stock value in days.",
            "nullable":true,
            "x-queryable":true
        },
        "SsQuantityPrior":{
            "type":"integer",
            "description":"Prior safety stock value.",
            "nullable":true,
            "x-queryable":true
        },
        "SsQuantitySuggested":{
            "type":"integer",
            "description":"Suggested safety stock value.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdatePoliciesExecute":{
            "title":"Run Update Policies Processes",
            "type":"array",
            "description":"Update of policies for selected item location combinations.",
            "items":{
                "$ref":"#/components/schemas/replenishmentPolicyComparisons-UpdatePoliciesExecute-item-response"
            }
        },
        "UpdateStatus":{
            "type":"integer",
            "description":"Updated status of the policy comparison row.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Run Accept-All Processes

Type: array

Title: Run Accept-All Processes

Acceptance of policies for selected item location combinations.

Show Source

• Array of: object replenishmentPolicyComparisons-AcceptAllExecute-item-response

{
    "title":"Run Accept-All Processes",
    "type":"array",
    "description":"Acceptance of policies for selected item location combinations.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPolicyComparisons-AcceptAllExecute-item-response"
    }
}

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 : Run Publish Par Processes

Type: array

Title: Run Publish Par Processes

Publishing of par policies for selected item locations.

Show Source

• Array of: object replenishmentPolicyComparisons-PublishParExecute-item-response

{
    "title":"Run Publish Par Processes",
    "type":"array",
    "description":"Publishing of par policies for selected item locations.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPolicyComparisons-PublishParExecute-item-response"
    }
}

Nested Schema : Run Update Policies Processes

Type: array

Title: Run Update Policies Processes

Update of policies for selected item location combinations.

Show Source

• Array of: object replenishmentPolicyComparisons-UpdatePoliciesExecute-item-response

{
    "title":"Run Update Policies Processes",
    "type":"array",
    "description":"Update of policies for selected item location combinations.",
    "items":{
        "$ref":"#/components/schemas/replenishmentPolicyComparisons-UpdatePoliciesExecute-item-response"
    }
}

Nested Schema : replenishmentPolicyComparisons-AcceptAllExecute-item-response

Type: object

Show Source

• ESSProcessId: integer (int64)
  Value that uniquely identifies the accept-all process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 4000

  Name of the message.
• WhereCondition: string
  Maximum Length: 4000

  Value that uniquely identifies the condition.

{
    "type":"object",
    "properties":{
        "ESSProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the accept-all process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Message":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "WhereCondition":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that uniquely identifies the condition.",
            "nullable":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"
    }
}

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 : replenishmentPolicyComparisons-PublishParExecute-item-response

Type: object

Show Source

• ESSProcessId: string
  Maximum Length: 255

  Value that uniquely identifies the publish par process.
• ExecutionId: integer (int64)
  Value that uniquely identifies the execution process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 4000

  Name of the message.
• PlanId: integer
  Value that uniquely identifies the plan.
• PolicyAssignmentSetId: integer
  Value that uniquely identifies the policy assignment set.
• SegmentGroupId: integer
  Value that uniquely identifies the segment group.

{
    "type":"object",
    "properties":{
        "ESSProcessId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the publish par process.",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the execution process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Message":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyAssignmentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the policy assignment set.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "nullable":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"
    }
}

Nested Schema : replenishmentPolicyComparisons-UpdatePoliciesExecute-item-response

Type: object

Show Source

• ESSProcessId: integer (int64)
  Value that uniquely identifies the update policies process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 4000

  Name of the message.
• PlanId: integer
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "ESSProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the update policies process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Message":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "nullable":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"
    }
}

Back to Top