Jump to

• Request
• Response
• Examples

Create one save backlog plan results job

post

/fscmRestApi/resources/11.13.18.05/bmSimulationPlanSaveJobs

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: number
  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 save backlog results job.
• CreationDate: string (date-time)
  Date when the user initially created the save backlog results job.
• DemandPriorityRuleId: integer (int64)
  Unique identifier of the demand priority rule used in a backlog management simulation plan run job.
• 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 whether the backlog plan results were successfully saved to the backlog management base plan.
• PlanStartDate: string (date-time)
  Plan start date used for the backlog management plan run.
• SavePlanExecutionId: integer (int64)
  Scheduled process that processes the save plan.
• SearchCriteria: string (byte)
  Filter criteria applied for the backlog management simulation plan run job.
• SimulationPlanSaveExecutions: array Save Simulation Plan Runs
  Title: Save Simulation Plan Runs

  The progress and status of each run of a save backlog plan results 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
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the save backlog results job.",
            "format":"date-time",
            "nullable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the save backlog results job.",
            "nullable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message that indicates whether the backlog plan results were successfully saved to the backlog management base plan.",
            "nullable":true
        },
        "SimulationPlanSaveExecutions":{
            "title":"Save Simulation Plan Runs",
            "type":"array",
            "description":"The progress and status of each run of a save backlog plan results job.",
            "items":{
                "$ref":"#/components/schemas/bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-post-request"
            }
        },
        "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
            }
        },
        "BmRunType":{
            "type":"number",
            "description":"Mode of the plan run, whether it's refresh and plan, or run plan.",
            "nullable":true
        },
        "SavePlanExecutionId":{
            "type":"integer",
            "description":"Scheduled process that processes the save plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanStartDate":{
            "type":"string",
            "description":"Plan start date used for the backlog management plan run.",
            "format":"date-time",
            "nullable":true
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":true
        },
        "SearchCriteria":{
            "type":"string",
            "description":"Filter criteria applied for the backlog management simulation plan run job.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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 : Save Simulation Plan Runs

Type: array

Title: Save Simulation Plan Runs

The progress and status of each run of a save backlog plan results job.

Show Source

• Array of: object bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-post-request

{
    "title":"Save Simulation Plan Runs",
    "type":"array",
    "description":"The progress and status of each run of a save backlog plan results job.",
    "items":{
        "$ref":"#/components/schemas/bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-post-request"
    }
}

Nested Schema : bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-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 : bmSimulationPlanSaveJobs-item-response

Type: object

Show Source

• BmRunId: integer
  Value that uniquely identifies the backlog management plan run.
• BmRunType: number
  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 save backlog results job.
• CreationDate: string (date-time)
  Date when the user initially created the save backlog results job.
• DemandPriorityRuleId: integer (int64)
  Unique identifier of the demand priority rule used in a backlog management simulation plan run job.
• 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 whether the backlog plan results were successfully saved to the backlog management base plan.
• PlanStartDate: string (date-time)
  Plan start date used for the backlog management plan run.
• SavePlanExecutionId: integer (int64)
  Scheduled process that processes the save plan.
• SearchCriteria: string (byte)
  Filter criteria applied for the backlog management simulation plan run job.
• SimulationPlanSaveExecutions: array Save Simulation Plan Runs
  Title: Save Simulation Plan Runs

  The progress and status of each run of a save backlog plan results 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
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the save backlog results job.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the save backlog results job.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message that indicates whether the backlog plan results were successfully saved to the backlog management base plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SavePlanExecutionId":{
            "type":"integer",
            "description":"Scheduled process that processes the save plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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 for the backlog management simulation plan run job.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SimulationPlanSaveExecutions":{
            "title":"Save Simulation Plan Runs",
            "type":"array",
            "description":"The progress and status of each run of a save backlog plan results job.",
            "items":{
                "$ref":"#/components/schemas/bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-response"
            }
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BmRunType":{
            "type":"number",
            "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
        },
        "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 : Save Simulation Plan Runs

Type: array

Title: Save Simulation Plan Runs

The progress and status of each run of a save backlog plan results job.

Show Source

• Array of: object bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-response

{
    "title":"Save Simulation Plan Runs",
    "type":"array",
    "description":"The progress and status of each run of a save backlog plan results job.",
    "items":{
        "$ref":"#/components/schemas/bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-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 : bmSimulationPlanSaveJobs-SimulationPlanSaveExecutions-item-response

Type: object

Show Source

• BmRunId: integer (int64)
  Read Only: true

  Value that uniquely identifies the backlog management plan run.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user initially created the save backlog plan results job.
• ExecutionId: integer
  Read Only: true

  Indicates the unique identifier of plan run process for which the backlog plan results is saved.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently saved the backlog plan results.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently saved the backlog plan results.
• links: array Links
  Title: Links

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

  Percent completion of the save backlog plan results job.
• Status: number
  Read Only: true

  Status of the save backlog plan results job. Valid values are 1 for success and 2 for failure. This attribute doesn't have a default value.
• StepSequence: number
  Read Only: true

  Value that identifies the step of the save backlog plan results job.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"number",
            "description":"Status of the save backlog plan results job. Valid values are 1 for success and 2 for failure. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently saved the backlog plan results.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initially created the save backlog plan results job.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StepSequence":{
            "type":"number",
            "description":"Value that identifies the step of the save backlog plan results job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the save backlog plan results job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageCompleted":{
            "type":"number",
            "description":"Percent completion of the save backlog plan results job.",
            "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"
            }
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Indicates the unique identifier of plan run process for which the backlog plan results is saved.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently saved the backlog plan results.",
            "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

SimulationPlanSaveExecutions

Operation: /fscmRestApi/resources/11.13.18.05/bmSimulationPlanSaveJobs/{bmSimulationPlanSaveJobsUniqID}/child/SimulationPlanSaveExecutions

Parameters:

• bmSimulationPlanSaveJobsUniqID: $request.path.bmSimulationPlanSaveJobsUniqID

The progress and status of each run of a save backlog plan results job.

Back to Top

Examples

This example describes how to create one save backlog plan results 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/bmSimulationPlanSaveJobs"

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.

{
    "BmRunId": 44011
}

Example Response Body

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

{
    "BmRunId": 44011,
    "SavePlanExecutionId": 278470,
    "BmRunType": 2,
    "PlanStartDate": "2030-01-07T00:00:00+00:00",
    "DemandPriorityRuleId": 300100178581705,
    "Message": 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",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanSaveJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FC6",
            "name": "bmSimulationPlanSaveJobs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanSaveJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FC6",
            "name": "bmSimulationPlanSaveJobs",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanSaveJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FC6/child/SimulationPlanSaveExecutions",
            "name": "SimulationPlanSaveExecutions",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/bmSimulationPlanSaveJobs/00020000000EACED00057708000000000000ABEB0000000EACED000577080000000000043FC6/enclosure/SearchCriteria",
            "name": "SearchCriteria",
            "kind": "other"
        }
    ]
}

Back to Top