Jump to

• Request
• Response

Create one new simulation request

post

/fscmRestApi/resources/11.13.18.05/simulateDemands

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DecompFcstMsrToTable: integer
  Indicator to add a decomposed forecast measure to the table. The value 1 indicates that a decomposed forecast measure has to be added to the table.
• DecompTotalMsrToTable: integer
  Indicator to add the total decomposed forecast measure to the table. The value 1 indicates that the total decomposed forecast measure has to be added to the table.
• ExecutionId: integer (int64)
  Value that uniquely identifies the simulate demand scheduled process execution.
• LevelMsrToTable: integer
  Indicator to the add forecast level measure to the table. The value 1 indicates that the forecast level measure is to added to the table.
• MethodsMsrToTable: integer
  Indicator to add forecast methods measure to the table. Value 1 indicates to add forecast methods measure to the table.
• MthdWghtMsrToTable: integer
  Indicator to add forecast method weight measure to the table. Value 1 indicates to add forecast method weight measure to the table.
• OutMsrToTable: integer
  Indicator to add the forecast output measure to the table. The value 1 indicates that the forecast output measure is to be added to the table.
• PageFilterLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table page filter.
• PageFilterMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table page filter.
• PivotTableFilterLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table member filter.
• PivotTableFilterMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table member filter.
• PlanId: integer (int64)
  Unique identifier of the plan associated with the simulate demand request.
• PlanType: integer (int64)
  Indicates the type of the plan associated with the simulate demand request. The value 1 indicates it's a demand plan. Value 3 indicates it's a demand and supply plan.
• ProfileId: integer (int64)
  Unique identifier of the forecast profile associated with the simulate demand request.
• ProfileName: string
  Maximum Length: 255

  Name of the forecast profile associated with the simulate demand request.
• SelType: string
  Maximum Length: 255

  Type of cell selected in the table. The value header indicates it's a level selection. The value cell indicates it's a data selection. The value null indicates it's a measure selection.
• SimFcstDecfcstMeasureId: integer (int64)
  Unique identifier of the measure that stores the decomposed forecast results generated by the simulate demand request.
• SimFcstDecomptotMeasureId: integer (int64)
  Unique identifier of the measure that stores the total decomposed forecast results generated by the simulate demand request.
• SimFcstLevelsMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast level used for generating the forecast.
• SimFcstMethodsMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast methods used for generating the forecast.
• SimFcstMthdWghtMeasureId: integer (int64)
  Unique identifier of the measure that stores the total decomposed forecast generated by the simulate demand request.
• SimFcstOutMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast results generated by the simulate demand request.
• SimScopeId: string
  Maximum Length: 255

  Indicates the type of simulate demand scope. The value 1 indicates it's a highlighted selection in table. The value 2 indicates it's a selected filter in the table. The value 3 indicates it's an entire table.
• SimulationId: integer (int64)
  Unique identifier of the simulation request.
• SrcProfileId: integer
  Unique identifier of the forecast profile used for creating a new forecast profile.
• TableSelectedLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table.
• TableSelectedMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecast profile associated with the simulate demand request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "TableSelectedLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "DecompFcstMsrToTable":{
            "type":"integer",
            "description":"Indicator to add a decomposed forecast measure to the table. The value 1 indicates that a decomposed forecast measure has to be added to the table.",
            "nullable":true
        },
        "ProfileName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the forecast profile associated with the simulate demand request.",
            "nullable":true
        },
        "PivotTableFilterMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table member filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "SimFcstMthdWghtMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the total decomposed forecast generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "SelType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of cell selected in the table. The value header indicates it's a level selection. The value cell indicates it's a data selection. The value null indicates it's a measure selection.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "DecompTotalMsrToTable":{
            "type":"integer",
            "description":"Indicator to add the total decomposed forecast measure to the table. The value 1 indicates that the total decomposed forecast measure has to be added to the table.",
            "nullable":true
        },
        "PageFilterLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table page filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "SimFcstOutMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "LevelMsrToTable":{
            "type":"integer",
            "description":"Indicator to the add forecast level measure to the table. The value 1 indicates that the forecast level measure is to added to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "MthdWghtMsrToTable":{
            "type":"integer",
            "description":"Indicator to add forecast method weight measure to the table. Value 1 indicates to add forecast method weight measure to the table.",
            "nullable":true
        },
        "PlanType":{
            "type":"integer",
            "description":"Indicates the type of the plan associated with the simulate demand request. The value 1 indicates it's a demand plan. Value 3 indicates it's a demand and supply plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "SimFcstMethodsMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast methods used for generating the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "SrcProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecast profile used for creating a new forecast profile.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "TableSelectedMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "MethodsMsrToTable":{
            "type":"integer",
            "description":"Indicator to add forecast methods measure to the table. Value 1 indicates to add forecast methods measure to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "PivotTableFilterLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table member filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "OutMsrToTable":{
            "type":"integer",
            "description":"Indicator to add the forecast output measure to the table. The value 1 indicates that the forecast output measure is to be added to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "SimFcstDecfcstMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the decomposed forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "PageFilterMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table page filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "SimFcstLevelsMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast level used for generating the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier of the simulation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SimFcstDecomptotMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the total decomposed forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            }
        },
        "SimScopeId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of simulate demand scope. The value 1 indicates it's a highlighted selection in table. The value 2 indicates it's a selected filter in the table. The value 3 indicates it's an entire table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            }
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulate demand scheduled process execution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• DecompFcstMsrToTable: integer
  Indicator to add a decomposed forecast measure to the table. The value 1 indicates that a decomposed forecast measure has to be added to the table.
• DecompTotalMsrToTable: integer
  Indicator to add the total decomposed forecast measure to the table. The value 1 indicates that the total decomposed forecast measure has to be added to the table.
• ExecutionId: integer (int64)
  Value that uniquely identifies the simulate demand scheduled process execution.
• LevelMsrToTable: integer
  Indicator to the add forecast level measure to the table. The value 1 indicates that the forecast level measure is to added to the table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MethodsMsrToTable: integer
  Indicator to add forecast methods measure to the table. Value 1 indicates to add forecast methods measure to the table.
• MthdWghtMsrToTable: integer
  Indicator to add forecast method weight measure to the table. Value 1 indicates to add forecast method weight measure to the table.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the simulate demand request.
• OutMsrToTable: integer
  Indicator to add the forecast output measure to the table. The value 1 indicates that the forecast output measure is to be added to the table.
• PageFilterLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table page filter.
• PageFilterMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table page filter.
• PivotTableFilterLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table member filter.
• PivotTableFilterMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table member filter.
• PlanId: integer (int64)
  Unique identifier of the plan associated with the simulate demand request.
• PlanType: integer (int64)
  Indicates the type of the plan associated with the simulate demand request. The value 1 indicates it's a demand plan. Value 3 indicates it's a demand and supply plan.
• ProfileId: integer (int64)
  Unique identifier of the forecast profile associated with the simulate demand request.
• ProfileName: string
  Maximum Length: 255

  Name of the forecast profile associated with the simulate demand request.
• SelType: string
  Maximum Length: 255

  Type of cell selected in the table. The value header indicates it's a level selection. The value cell indicates it's a data selection. The value null indicates it's a measure selection.
• SimFcstDecfcstMeasureId: integer (int64)
  Unique identifier of the measure that stores the decomposed forecast results generated by the simulate demand request.
• SimFcstDecomptotMeasureId: integer (int64)
  Unique identifier of the measure that stores the total decomposed forecast results generated by the simulate demand request.
• SimFcstLevelsMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast level used for generating the forecast.
• SimFcstMethodsMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast methods used for generating the forecast.
• SimFcstMthdWghtMeasureId: integer (int64)
  Unique identifier of the measure that stores the total decomposed forecast generated by the simulate demand request.
• SimFcstOutMeasureId: integer (int64)
  Unique identifier of the measure that stores the forecast results generated by the simulate demand request.
• SimScopeId: string
  Maximum Length: 255

  Indicates the type of simulate demand scope. The value 1 indicates it's a highlighted selection in table. The value 2 indicates it's a selected filter in the table. The value 3 indicates it's an entire table.
• SimulationId: integer (int64)
  Unique identifier of the simulation request.
• SrcProfileId: integer
  Unique identifier of the forecast profile used for creating a new forecast profile.
• TableSelectedLevels: string
  Maximum Length: 255

  Unique identifier of the levels selected in the table.
• TableSelectedMembers: string
  Maximum Length: 255

  Unique identifier of the level members selected in the table.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecast profile associated with the simulate demand request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "TableSelectedLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "DecompFcstMsrToTable":{
            "type":"integer",
            "description":"Indicator to add a decomposed forecast measure to the table. The value 1 indicates that a decomposed forecast measure has to be added to the table.",
            "nullable":true,
            "x-queryable":true
        },
        "ProfileName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the forecast profile associated with the simulate demand request.",
            "nullable":true,
            "x-queryable":true
        },
        "PivotTableFilterMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table member filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "SimFcstMthdWghtMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the total decomposed forecast generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "SelType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of cell selected in the table. The value header indicates it's a level selection. The value cell indicates it's a data selection. The value null indicates it's a measure selection.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "DecompTotalMsrToTable":{
            "type":"integer",
            "description":"Indicator to add the total decomposed forecast measure to the table. The value 1 indicates that the total decomposed forecast measure has to be added to the table.",
            "nullable":true,
            "x-queryable":true
        },
        "PageFilterLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table page filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "SimFcstOutMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "LevelMsrToTable":{
            "type":"integer",
            "description":"Indicator to the add forecast level measure to the table. The value 1 indicates that the forecast level measure is to added to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "MthdWghtMsrToTable":{
            "type":"integer",
            "description":"Indicator to add forecast method weight measure to the table. Value 1 indicates to add forecast method weight measure to the table.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the simulate demand request.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanType":{
            "type":"integer",
            "description":"Indicates the type of the plan associated with the simulate demand request. The value 1 indicates it's a demand plan. Value 3 indicates it's a demand and supply plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "SimFcstMethodsMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast methods used for generating the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrcProfileId":{
            "type":"integer",
            "description":"Unique identifier of the forecast profile used for creating a new forecast profile.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "TableSelectedMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "MethodsMsrToTable":{
            "type":"integer",
            "description":"Indicator to add forecast methods measure to the table. Value 1 indicates to add forecast methods measure to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "PivotTableFilterLevels":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the levels selected in the table member filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan associated with the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "OutMsrToTable":{
            "type":"integer",
            "description":"Indicator to add the forecast output measure to the table. The value 1 indicates that the forecast output measure is to be added to the table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "SimFcstDecfcstMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the decomposed forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "PageFilterMembers":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the level members selected in the table page filter.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "SimFcstLevelsMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the forecast level used for generating the forecast.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier of the simulation request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimFcstDecomptotMeasureId":{
            "type":"integer",
            "description":"Unique identifier of the measure that stores the total decomposed forecast results generated by the simulate demand request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "post":"true",
                "precision":18
            },
            "x-queryable":true
        },
        "SimScopeId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the type of simulate demand scope. The value 1 indicates it's a highlighted selection in table. The value 2 indicates it's a selected filter in the table. The value 3 indicates it's an entire table.",
            "nullable":true,
            "x-hints":{
                "post":"true"
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulate demand scheduled process execution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top