Jump to

• Request
• Response

Get all plan schedules

get

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanSchedule

Request

Path Parameters

• PlanId(required): integer(int64)
  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
• 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 plan schedule according to the value that identifies the plan schedule.
    Finder Variables
    • TransactionId; integer; Value that uniquely identifies the plan schedule.
• 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:
  

  • AverageArrivalTimeMeasureId; integer; Holds the measure identifier of the average interarrival time in the forecast accuracy measures for the plan schedule.
  • ConsumeComFcstIndicator; integer; Number of days during which planned orders from the feeding production schedule are considered by the supply plan.
  • CreatedBy; string; Name of the user who created the plan.
  • CreationDate; string; Date when the plan was originally created.
  • DemandPlanOutput; integer; Demand plan output measure ID to copy to the supply plan input measure.
  • DemandVariabilityType; number; Type of demand variability to use when calculating the safety stock for the forecasted demand. Valid values are Mean Absolute Deviation, Mean Absolute Percentage Error, and Intermittent.
  • DesignatorType; number; Short code for the type of demand schedule.
  • DesignatorTypeText; string; Name for type of demand schedule.
  • EndItemDemMeasureId; integer; Forecast measure for demand for end items.
  • FirmHorizonDays; number; Number of days during which planned orders from the feeding production schedule are considered by the supply plan.
  • IncludePO; number; Indicates whether purchase orders are used. The possible values are 1 for Yes and 2 for No.
  • IncludePlnOrd; number; Indicates whether planned orders are used. The possible values are 1 for Yes and 2 for No.
  • IncludePsResultsIndicator; integer; Enables the supply plan to include the output of the production scheduling in its next plan run.
  • IncludeTargetDemands; number; Value that indicates whether the target demand is used. Possible values are 1-Yes and 2-No.
  • IndepDemMeasureId; integer; Selected measure that contains the independent demand.
  • InputScheduleId; integer; Identifier of the demand plan schedule to be consumed in a supply plan.
  • InputType; number; Short code for the type of demand schedule.
  • IntermittentDemMeasureId; integer; Demand measure that indicates whether the demand has an irregular demand pattern.
  • InterplantDemandIndicator; number; Indicates whether the interplant demand is used. The possible values are 1 for Yes and 2 for No.
  • LastUpdateDate; string; Date when the user most recently updated the plan.
  • LastUpdateLogin; string; Last time the user logged into the system.
  • LastUpdatedBy; string; User who performed the most recent update on the plan.
  • MadOrMapeMeasureId; integer; ID of the MAD or MAPE forecast error measure.
  • MadOrMapeMeasureType; integer; Specifies whether the forecast error type is MAD or MAPE. This is applicable for demand that's not intermittent.
  • MapeValue; integer; Value of the mean absolute percentage error for the item-organization combination.
  • ObjectVersionNumber; integer; Plan version number.
  • OptionDemandMeasureId; integer; ID of the option demand measure of the forecast.
  • OrganizationId; integer; Organization name. Set to 23453 for schedules to indicate that their forecast error type isn't organization-specific.
  • PlanId; integer; Value that uniquely identifies the plan.
  • PlanningPercentMeasureId; integer; ID of the planning percentage measure for the forecast.
  • PolicyParameters; number; Header for a column with the value used to specify whether to use the policy parameters of the specified plan.
  • Probability; integer; Indicates the probability value of the schedule.
  • ReplDemandSchedules; integer; Indicates whether to use a specific schedule as a demand schedule.
  • ScenarioSet; integer; Identifies the scenario set to be used in calculations.
  • ShipTo; integer; Forecast consumption level for the demand schedule. Values vary depending on the published level of the demand schedule.
  • SupplyPlanInput; integer; Identifier of the demand schedule measure to use in supply planning.
  • TransactionId; integer; Value that uniquely identifies the demand plan schedule.
• 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 : planOptions-PlanSchedule

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/planOptions-PlanSchedule-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object planOptions-PlanSchedule-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/planOptions-PlanSchedule-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 : planOptions-PlanSchedule-item-response

Type: object

Show Source

• AverageArrivalTimeMeasureId: integer (int64)
  Holds the measure identifier of the average interarrival time in the forecast accuracy measures for the plan schedule.
• ConsumeComFcstIndicator: integer
  Number of days during which planned orders from the feeding production schedule are considered by the supply plan.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the plan.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan was originally created.
• DemandPlanOutput: integer (int64)
  Demand plan output measure ID to copy to the supply plan input measure.
• DemandVariabilityType: number
  Type of demand variability to use when calculating the safety stock for the forecasted demand. Valid values are Mean Absolute Deviation, Mean Absolute Percentage Error, and Intermittent.
• DesignatorType: number
  Short code for the type of demand schedule.
• DesignatorTypeText: string
  Read Only: true

  Maximum Length: 255

  Name for type of demand schedule.
• EndItemDemMeasureId: integer (int64)
  Forecast measure for demand for end items.
• FcstConstPlanningAttr: array Forecast Constrained Planning Attributes
  Title: Forecast Constrained Planning Attributes

  The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.
• FirmHorizonDays: number
  Number of days during which planned orders from the feeding production schedule are considered by the supply plan.
• IncludePlnOrd: number
  Indicates whether planned orders are used. The possible values are 1 for Yes and 2 for No.
• IncludePO: number
  Indicates whether purchase orders are used. The possible values are 1 for Yes and 2 for No.
• IncludePsResultsIndicator: integer (int32)
  Enables the supply plan to include the output of the production scheduling in its next plan run.
• IncludeTargetDemands: number
  Value that indicates whether the target demand is used. Possible values are 1-Yes and 2-No.
• IndepDemMeasureId: integer (int64)
  Selected measure that contains the independent demand.
• InputScheduleDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the demand plan schedule to be consumed in a supply plan.
• InputScheduleId: integer (int64)
  Identifier of the demand plan schedule to be consumed in a supply plan.
• InputScheduleName: string
  Read Only: true

  Maximum Length: 255

  Name of the demand plan schedule to be consumed in a supply plan.
• InputType: number
  Short code for the type of demand schedule.
• IntermittentDemMeasureId: integer (int64)
  Demand measure that indicates whether the demand has an irregular demand pattern.
• InterplantDemandIndicator: number
  Indicates whether the interplant demand is used. The possible values are 1 for Yes and 2 for No.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MadOrMapeMeasureId: integer (int64)
  ID of the MAD or MAPE forecast error measure.
• MadOrMapeMeasureType: integer (int32)
  Specifies whether the forecast error type is MAD or MAPE. This is applicable for demand that's not intermittent.
• MapeValue: integer (int64)
  Value of the mean absolute percentage error for the item-organization combination.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• OptionDemandMeasureId: integer (int64)
  ID of the option demand measure of the forecast.
• OrganizationId: integer (int64)
  Organization name. Set to 23453 for schedules to indicate that their forecast error type isn't organization-specific.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.
• PlanningPercentMeasureId: integer (int64)
  ID of the planning percentage measure for the forecast.
• PlanScheduleMeasureLevel: array Plan Schedule Measure Levels
  Title: Plan Schedule Measure Levels

  The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.
• PolicyParameters: number
  Header for a column with the value used to specify whether to use the policy parameters of the specified plan.
• Probability: integer (int64)
  Indicates the probability value of the schedule.
• ReplDemandSchedules: integer (int32)
  Indicates whether to use a specific schedule as a demand schedule.
• ScenarioSet: integer (int64)
  Identifies the scenario set to be used in calculations.
• ShipTo: integer (int64)
  Forecast consumption level for the demand schedule. Values vary depending on the published level of the demand schedule.
• SupplyPlanInput: integer (int64)
  Identifier of the demand schedule measure to use in supply planning.
• TransactionId: integer (int64)
  Value that uniquely identifies the demand plan schedule.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandPlanOutput":{
            "type":"integer",
            "description":"Demand plan output measure ID to copy to the supply plan input measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DesignatorTypeText":{
            "maxLength":255,
            "type":"string",
            "description":"Name for type of demand schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization name. Set to 23453 for schedules to indicate that their forecast error type isn't organization-specific.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AverageArrivalTimeMeasureId":{
            "type":"integer",
            "description":"Holds the measure identifier of the average interarrival time in the forecast accuracy measures for the plan schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntermittentDemMeasureId":{
            "type":"integer",
            "description":"Demand measure that indicates whether the demand has an irregular demand pattern.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplDemandSchedules":{
            "type":"integer",
            "description":"Indicates whether to use a specific schedule as a demand schedule.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "IndepDemMeasureId":{
            "type":"integer",
            "description":"Selected measure that contains the independent demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FirmHorizonDays":{
            "type":"number",
            "description":"Number of days during which planned orders from the feeding production schedule are considered by the supply 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"
            }
        },
        "SupplyPlanInput":{
            "type":"integer",
            "description":"Identifier of the demand schedule measure to use in supply planning.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScenarioSet":{
            "type":"integer",
            "description":"Identifies the scenario set to be used in calculations.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputScheduleDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the demand plan schedule to be consumed in a supply plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PolicyParameters":{
            "type":"number",
            "description":"Header for a column with the value used to specify whether to use the policy parameters of the specified plan.",
            "nullable":true,
            "x-queryable":true
        },
        "MadOrMapeMeasureType":{
            "type":"integer",
            "description":"Specifies whether the forecast error type is MAD or MAPE. This is applicable for demand that's not intermittent.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "FcstConstPlanningAttr":{
            "title":"Forecast Constrained Planning Attributes",
            "type":"array",
            "description":"The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.",
            "items":{
                "$ref":"#/components/schemas/planOptions-PlanSchedule-FcstConstPlanningAttr-item-response"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MadOrMapeMeasureId":{
            "type":"integer",
            "description":"ID of the MAD or MAPE forecast error measure.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConsumeComFcstIndicator":{
            "type":"integer",
            "description":"Number of days during which planned orders from the feeding production schedule are considered by the supply plan.",
            "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
        },
        "Probability":{
            "type":"integer",
            "description":"Indicates the probability value of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputScheduleName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the demand plan schedule to be consumed in a supply plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DesignatorType":{
            "type":"number",
            "description":"Short code for the type of demand schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "MapeValue":{
            "type":"integer",
            "description":"Value of the mean absolute percentage error for the item-organization combination.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludePsResultsIndicator":{
            "type":"integer",
            "description":"Enables the supply plan to include the output of the production scheduling in its next plan run.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "IncludePlnOrd":{
            "type":"number",
            "description":"Indicates whether planned orders are used. The possible values are 1 for Yes and 2 for No.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand plan schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputType":{
            "type":"number",
            "description":"Short code for the type of demand schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningPercentMeasureId":{
            "type":"integer",
            "description":"ID of the planning percentage measure for the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandVariabilityType":{
            "type":"number",
            "description":"Type of demand variability to use when calculating the safety stock for the forecasted demand. Valid values are Mean Absolute Deviation, Mean Absolute Percentage Error, and Intermittent.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludeTargetDemands":{
            "type":"number",
            "description":"Value that indicates whether the target demand is used. Possible values are 1-Yes and 2-No.",
            "nullable":true,
            "x-queryable":true
        },
        "InterplantDemandIndicator":{
            "type":"number",
            "description":"Indicates whether the interplant demand is used. The possible values are 1 for Yes and 2 for No.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipTo":{
            "type":"integer",
            "description":"Forecast consumption level for the demand schedule. Values vary depending on the published level of the demand schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptionDemandMeasureId":{
            "type":"integer",
            "description":"ID of the option demand measure of the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndItemDemMeasureId":{
            "type":"integer",
            "description":"Forecast measure for demand for end items.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputScheduleId":{
            "type":"integer",
            "description":"Identifier of the demand plan schedule to be consumed in a supply plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanScheduleMeasureLevel":{
            "title":"Plan Schedule Measure Levels",
            "type":"array",
            "description":"The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.",
            "items":{
                "$ref":"#/components/schemas/planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludePO":{
            "type":"number",
            "description":"Indicates whether purchase orders are used. The possible values are 1 for Yes and 2 for No.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Forecast Constrained Planning Attributes

Type: array

Title: Forecast Constrained Planning Attributes

The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.

Show Source

• Array of: object planOptions-PlanSchedule-FcstConstPlanningAttr-item-response

{
    "title":"Forecast Constrained Planning Attributes",
    "type":"array",
    "description":"The attributes for a demand schedule attached to a plan. User can enable or disable these attributes for forecast consumption by the demand schedules attached to the plan. These attributes, such as Backward Days and Forward Days, determine the range of days from the forecast demand date that the forecast can be consumed in that range by sales orders.",
    "items":{
        "$ref":"#/components/schemas/planOptions-PlanSchedule-FcstConstPlanningAttr-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 : Plan Schedule Measure Levels

Type: array

Title: Plan Schedule Measure Levels

The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.

Show Source

• Array of: object planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response

{
    "title":"Plan Schedule Measure Levels",
    "type":"array",
    "description":"The plan schedule measure levels specified for a demand schedule in the plan options. In supply planning, dimensions such as time can have multiple measure levels. Users can specify measure levels for these dimensions: Time, Demand Class, Customer, Organization, and Product. For example the level for Time could be Day, the level for Customer could be Customer Site, and the level for Product could be Item. On the other hand, the level for organization is fixed as Organization and the level for demand class is only Demand Class.",
    "items":{
        "$ref":"#/components/schemas/planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response"
    }
}

Nested Schema : planOptions-PlanSchedule-FcstConstPlanningAttr-item-response

Type: object

Show Source

• AttributeId: integer (int64)
  Unique identifier of the forecast constrained planning attribute.
• AttributeName: string
  Read Only: true

  Maximum Length: 255

  Name of the forecast constrained planning attribute.
• AttributeNumber: integer
  Value that uniquely identifies the forecast constrained planning attribute.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the plan.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan was originally created.
• Enabled: integer (int32)
  Indicates whether the forecast consumption process is enabled for planning.
• InputScheduleId: integer (int64)
  Identifier of the demand plan schedule to be consumed in a supply plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Unique identifier of the forecast constrained planning attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Enabled":{
            "type":"integer",
            "description":"Indicates whether the forecast consumption process is enabled for planning.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AttributeNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the forecast constrained planning attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the forecast constrained planning attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputScheduleId":{
            "type":"integer",
            "description":"Identifier of the demand plan schedule to be consumed in a supply plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : planOptions-PlanSchedule-PlanScheduleMeasureLevel-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the plan.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan was originally created.
• DimensionId: integer (int64)
  Identifier of the dimension at which to load input measures.
• DimensionName: string
  Read Only: true

  Maximum Length: 255

  Name of the dimension for which to load input measures.
• HierarchyId: integer (int64)
  Identifier of the hierarchy at which to load input measures.
• HierarchyName: string
  Read Only: true

  Maximum Length: 255

  Name of the hierarchy selected for the plan schedule measure.
• InputScheduleId: integer (int64)
  Identifier of the demand plan schedule to be consumed in a supply plan.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• LevelId: integer (int64)
  Identifier of the dimension level at which to load input measures.
• LevelName: string
  Read Only: true

  Maximum Length: 255

  Name of the hierarchy level selected for the plan schedule measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan version number.
• PlanId: integer (int64)
  Value that uniquely identifies the plan.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the plan.",
            "nullable":false,
            "readOnly":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
        },
        "HierarchyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the hierarchy selected for the plan schedule measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DimensionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the dimension for which to load input measures.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "HierarchyId":{
            "type":"integer",
            "description":"Identifier of the hierarchy at which to load input measures.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the hierarchy level selected for the plan schedule measure.",
            "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"
            }
        },
        "InputScheduleId":{
            "type":"integer",
            "description":"Identifier of the demand plan schedule to be consumed in a supply plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Identifier of the dimension at which to load input measures.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LevelId":{
            "type":"integer",
            "description":"Identifier of the dimension level at which to load input measures.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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