Jump to

• Request
• Response
• Examples

Create one backlog management simulation plan run job

post

/fscmRestApi/resources/11.13.18.05/bmSimulationPlanRunJobs

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

• BmRunId: integer
  Value that uniquely identifies the backlog management plan run.
• BmRunType: integer
  Mode of the plan run, whether it's Refresh and Plan or Run Plan.
• CreatedBy: string
  Maximum Length: 64

  Name of the user who initially created the backlog management simulation plan run job.
• CreationDate: string (date-time)
  Date when the user initially created the backlog management simulation plan run job.
• DemandPriorityRuleId: integer (int64)
  Unique identifier of the demand priority rule used in a backlog management simulation plan run job.
• DemandPriorityRuleName: string
  Name of a demand priority rule used in a backlog management simulation plan run job.
• EditedAttributeList: string
  List of all attributes that are edited on the backlog analysis page across all the demands in search results.
• EditedDemandList: string
  List of all demands along with the edited values for the demand attributes.
• ExecutionId: integer (int64)
  Value that uniquely identifies the process of the backlog management plan run.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the data in the backlog management plan run.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the data in the backlog management plan run.
• Message: string
  Maximum Length: 255

  Message that indicates if the attribute was successfully created or not in a demand priority rule.
• PlanStartDate: string (date-time)
  Plan start date used for the backlog management plan run.
• SearchCriteria: string
  Filter criteria applied on the backlog analysis page that's used in the backlog management simulation plan run job.
• SimulationPlanRunExecutions: array Simulation Plan Run Executions
  Title: Simulation Plan Run Executions

  The progress and status of each run of a backlog management simulation plan.
• SplitAttributeList: string
  List of attributes that are specific to split demands, which get changed due to the previous plan run.
• SplitDemandList: string
  List of demands that were split because of the backlog management simulation plan run job.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the data in the backlog management plan run.",
            "nullable":true
        },
        "SplitAttributeList":{
            "type":"string",
            "description":"List of attributes that are specific to split demands, which get changed due to the previous plan run.",
            "nullable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the backlog management simulation plan run job.",
            "format":"date-time",
            "nullable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the backlog management simulation plan run job.",
            "nullable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message that indicates if the attribute was successfully created or not in a demand priority rule.",
            "nullable":true
        },
        "DemandPriorityRuleName":{
            "type":"string",
            "description":"Name of a demand priority rule used in a backlog management simulation plan run job.",
            "nullable":true
        },
        "SplitDemandList":{
            "type":"string",
            "description":"List of demands that were split because of the backlog management simulation plan run job.",
            "nullable":true
        },
        "EditedAttributeList":{
            "type":"string",
            "description":"List of all attributes that are edited on the backlog analysis page across all the demands in search results.",
            "nullable":true,
            "x-queryable":false
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":true
        },
        "SearchCriteria":{
            "type":"string",
            "description":"Filter criteria applied on the backlog analysis page that's used in the backlog management simulation plan run job.",
            "nullable":true,
            "x-queryable":false
        },
        "EditedDemandList":{
            "type":"string",
            "description":"List of all demands along with the edited values for the demand attributes.",
            "nullable":true
        },
        "DemandPriorityRuleId":{
            "type":"integer",
            "description":"Unique identifier of the demand priority rule used in a backlog management simulation plan run job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SimulationPlanRunExecutions":{
            "title":"Simulation Plan Run Executions",
            "type":"array",
            "description":"The progress and status of each run of a backlog management simulation plan.",
            "items":{
                "$ref":"#/components/schemas/bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-post-request"
            }
        },
        "BmRunType":{
            "type":"integer",
            "description":"Mode of the plan run, whether it's Refresh and Plan or Run Plan.",
            "nullable":true
        },
        "PlanStartDate":{
            "type":"string",
            "description":"Plan start date used for the backlog management plan run.",
            "format":"date-time",
            "nullable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process of the backlog management plan run.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the data in the backlog management plan run.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Nested Schema : Simulation Plan Run Executions

Type: array

Title: Simulation Plan Run Executions

The progress and status of each run of a backlog management simulation plan.

Show Source

• Array of: object bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-post-request

{
    "title":"Simulation Plan Run Executions",
    "type":"array",
    "description":"The progress and status of each run of a backlog management simulation plan.",
    "items":{
        "$ref":"#/components/schemas/bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-post-request"
    }
}

Nested Schema : bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• BmRunId: integer
  Value that uniquely identifies the backlog management plan run.
• BmRunType: integer
  Mode of the plan run, whether it's Refresh and Plan or Run Plan.
• CreatedBy: string
  Maximum Length: 64

  Name of the user who initially created the backlog management simulation plan run job.
• CreationDate: string (date-time)
  Date when the user initially created the backlog management simulation plan run job.
• DemandPriorityRuleId: integer (int64)
  Unique identifier of the demand priority rule used in a backlog management simulation plan run job.
• DemandPriorityRuleName: string
  Name of a demand priority rule used in a backlog management simulation plan run job.
• EditedAttributeList: string
  List of all attributes that are edited on the backlog analysis page across all the demands in search results.
• EditedDemandList: string
  List of all demands along with the edited values for the demand attributes.
• ExecutionId: integer (int64)
  Value that uniquely identifies the process of the backlog management plan run.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the data in the backlog management plan run.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the data in the backlog management plan run.
• links: array Links
  Title: Links

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

  Message that indicates if the attribute was successfully created or not in a demand priority rule.
• PlanStartDate: string (date-time)
  Plan start date used for the backlog management plan run.
• SearchCriteria: string
  Filter criteria applied on the backlog analysis page that's used in the backlog management simulation plan run job.
• SimulationPlanRunExecutions: array Simulation Plan Run Executions
  Title: Simulation Plan Run Executions

  The progress and status of each run of a backlog management simulation plan.
• SplitAttributeList: string
  List of attributes that are specific to split demands, which get changed due to the previous plan run.
• SplitDemandList: string
  List of demands that were split because of the backlog management simulation plan run job.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the data in the backlog management plan run.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitAttributeList":{
            "type":"string",
            "description":"List of attributes that are specific to split demands, which get changed due to the previous plan run.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the backlog management simulation plan run job.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the backlog management simulation plan run job.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message that indicates if the attribute was successfully created or not in a demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandPriorityRuleName":{
            "type":"string",
            "description":"Name of a demand priority rule used in a backlog management simulation plan run job.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitDemandList":{
            "type":"string",
            "description":"List of demands that were split because of the backlog management simulation plan run job.",
            "nullable":true,
            "x-queryable":true
        },
        "EditedAttributeList":{
            "type":"string",
            "description":"List of all attributes that are edited on the backlog analysis page across all the demands in search results.",
            "nullable":true,
            "x-queryable":false
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchCriteria":{
            "type":"string",
            "description":"Filter criteria applied on the backlog analysis page that's used in the backlog management simulation plan run job.",
            "nullable":true,
            "x-queryable":false
        },
        "EditedDemandList":{
            "type":"string",
            "description":"List of all demands along with the edited values for the demand attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandPriorityRuleId":{
            "type":"integer",
            "description":"Unique identifier of the demand priority rule used in a backlog management simulation plan run job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationPlanRunExecutions":{
            "title":"Simulation Plan Run Executions",
            "type":"array",
            "description":"The progress and status of each run of a backlog management simulation plan.",
            "items":{
                "$ref":"#/components/schemas/bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BmRunType":{
            "type":"integer",
            "description":"Mode of the plan run, whether it's Refresh and Plan or Run Plan.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanStartDate":{
            "type":"string",
            "description":"Plan start date used for the backlog management plan run.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process of the backlog management plan run.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the data in the backlog management plan run.",
            "format":"date-time",
            "nullable":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 : Simulation Plan Run Executions

Type: array

Title: Simulation Plan Run Executions

The progress and status of each run of a backlog management simulation plan.

Show Source

• Array of: object bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-response

{
    "title":"Simulation Plan Run Executions",
    "type":"array",
    "description":"The progress and status of each run of a backlog management simulation plan.",
    "items":{
        "$ref":"#/components/schemas/bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : bmSimulationPlanRunJobs-SimulationPlanRunExecutions-item-response

Type: object

Show Source

• BmRunId: integer
  Read Only: true

  Value that uniquely identifies the simulation plan run execution.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user initially created the backlog management simulation plan run.
• ExecutionId: integer (int64)
  Read Only: true

  Identifier of the scheduled process that's launched for the backlog plan run.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the backlog management simulation plan run.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanRunStatus: number
  Read Only: true

  Status of the backlog management simulation plan run. Valid values are 1 for success and 2 for failure and percentage completion. This attribute doesn't have a default value.
• RunPercentageCompleted: number
  Read Only: true

  Percent completion of the backlog management plan run.
• StepSequenceNumber: number
  Read Only: true

  Value that identifies the step of the backlog management plan run. There are 10 steps.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the backlog management simulation plan run.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the backlog management simulation plan run.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the backlog management simulation plan run.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StepSequenceNumber":{
            "type":"number",
            "description":"Value that identifies the step of the backlog management plan run. There are 10 steps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunPercentageCompleted":{
            "type":"number",
            "description":"Percent completion of the backlog management plan run.",
            "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"
            }
        },
        "PlanRunStatus":{
            "type":"number",
            "description":"Status of the backlog management simulation plan run. Valid values are 1 for success and 2 for failure and percentage completion. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the simulation plan run execution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Identifier of the scheduled process that's launched for the backlog plan run.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the backlog management simulation plan run.",
            "format":"date-time",
            "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"
    }
}

Links

SimulationPlanRunExecutions

Operation: /fscmRestApi/resources/11.13.18.05/bmSimulationPlanRunJobs/{bmSimulationPlanRunJobsUniqID}/child/SimulationPlanRunExecutions

Parameters:

• bmSimulationPlanRunJobsUniqID: $request.path.bmSimulationPlanRunJobsUniqID

The progress and status of each run of a backlog management simulation plan.

Back to Top

Examples

This example describes how to create one backlog management simulation plan run job.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/bmSimulationPlanRunJobs"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
      "DemandPriorityRuleId":300100178581705,
      "SearchCriteria":" :DELIMETER:  OrderNumber like '%BLM-PHANTOM-SO%'",
      "BmRunType":2,"EditedAttributeList":null,
      "EditedDemandList":null,
      "Message":"1",
      "SplitAttributeList":null,
      "SplitDemandList":null
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "BmRunId": 44011,
    "ExecutionId": 278453,
    "BmRunType": 2,
    "PlanStartDate": "2030-01-07",
    "DemandPriorityRuleId": 300100178581705,
    "DemandPriorityRuleName": "Default_reqdate_revenue",
    "SearchCriteria": " :DELIMETER:  OrderNumber like '%BLM-PHANTOM-SO%'",
    "EditedAttributeList": null,
    "EditedDemandList": null,
    "SplitAttributeList": null,
    "SplitDemandList": null,
    "CreatedBy": "BLM_ALL",
    "CreationDate": "2025-02-22T00:16:04.139+00:00",
    "LastUpdatedBy": "BLM_ALL",
    "LastUpdateDate": "2025-02-22T00:16:04.139+00:00",
    "Message": "1",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanRunJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FB5",
            "name": "bmSimulationPlanRunJobs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanRunJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FB5",
            "name": "bmSimulationPlanRunJobs",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanRunJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FB5/child/SimulationPlanRunExecutions",
            "name": "SimulationPlanRunExecutions",
            "kind": "collection"
        }
    ]
}

Back to Top