Jump to

• Request
• Response
• Examples

Create backlog planning options

post

/fscmRestApi/resources/11.13.18.05/backlogPlanningOptions

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BucketsPerHorizon: integer (int64)
  Title: Planning Horizon in Days

  Value that specifies the number of days over which demand is considered by backlog plan.
• CalculateConstraint: integer
  Title: Display constraints for configure-to-order items, shipment sets, and arrival sets

  Value that indicates whether the constraints for configure-to-order and sets order will be calculated by the backlog plan.
• CategorySetId: integer
  Value that uniquely identifies the category set.
• ConfigurationId: integer (int64)
  Value that uniquely identifies the backlog plan run.
• DaysPastdue: integer
  Title: Past-Due Supply and Demand Considered in Days

  Value that determines which past due supplies and demands are considered in the backlog plan.
• DefaultAssignmentSetId: integer
  Value that uniquely identifies the assignment set.
• DefaultAssignmentSetName: string
  Title: Assignment Set Name

  Maximum Length: 255

  Name of the assignment set used.
• DefaultPriorityRuleId: integer
  Value that uniquely identifies the demand priority rule.
• DefaultPriorityRuleName: string
  Title: Demand Priority Rule

  Maximum Length: 255

  Name of the default priority rule that's used in planning demands in backlog management.
• DemFulfilLeadTime: integer
  Title: Default Demand Fulfillment Lead Time in Days

  Value that specifies the default lead time that's used to determine the fulfillment lead time date on demands.
• HorizonStart: string (date-time)
  Title: Horizon Start Date

  Date that signifies the start of the planning horizon and is typically defaulted to the system date.
• LastBaselineHorizonStart: string (date-time)
  Date that indicates the start of planning horizon for previous base line plan run.
• Message: string
  Maximum Length: 255

  Text of the error message, if any, encountered when creating or updating the backlog planning options.
• SupplyPlan: string
  Title: Supply Plans

  Maximum Length: 4000

  Values of the supply plan unique identifiers or the plan ID that are used as supply schedules in backlog management.
• SupplyPlanName: string
  Maximum Length: 255

  Names of the supply plans that are used as supply schedules in backlog management.

{
    "type":"object",
    "properties":{
        "CalculateConstraint":{
            "title":"Display constraints for configure-to-order items, shipment sets, and arrival sets",
            "type":"integer",
            "description":"Value that indicates whether the constraints for configure-to-order and sets order will be calculated by the backlog plan.",
            "nullable":true
        },
        "HorizonStart":{
            "title":"Horizon Start Date",
            "type":"string",
            "description":"Date that signifies the start of the planning horizon and is typically defaulted to the system date.",
            "format":"date-time",
            "nullable":true
        },
        "Message":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message, if any, encountered when creating or updating the backlog planning options.",
            "nullable":true
        },
        "DefaultPriorityRuleName":{
            "title":"Demand Priority Rule",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the default priority rule that's used in planning demands in backlog management.",
            "nullable":true
        },
        "LastBaselineHorizonStart":{
            "type":"string",
            "description":"Date that indicates the start of planning horizon for previous base line plan run.",
            "format":"date-time",
            "nullable":true
        },
        "DefaultPriorityRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand priority rule.",
            "nullable":true
        },
        "DefaultAssignmentSetName":{
            "title":"Assignment Set Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the assignment set used.",
            "nullable":true
        },
        "DemFulfilLeadTime":{
            "title":"Default Demand Fulfillment Lead Time in Days",
            "type":"integer",
            "description":"Value that specifies the default lead time that's used to determine the fulfillment lead time date on demands.",
            "nullable":true
        },
        "BucketsPerHorizon":{
            "title":"Planning Horizon in Days",
            "type":"integer",
            "description":"Value that specifies the number of days over which demand is considered by backlog plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog plan run.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            }
        },
        "SupplyPlan":{
            "title":"Supply Plans",
            "maxLength":"4000",
            "type":"string",
            "description":"Values of the supply plan unique identifiers or the plan ID that are used as supply schedules in backlog management.",
            "nullable":true
        },
        "DefaultAssignmentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assignment set.",
            "nullable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set.",
            "nullable":true
        },
        "DaysPastdue":{
            "title":"Past-Due Supply and Demand Considered in Days",
            "type":"integer",
            "description":"Value that determines which past due supplies and demands are considered in the backlog plan.",
            "nullable":true
        },
        "SupplyPlanName":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the supply plans that are used as supply schedules in backlog management.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• BucketsPerHorizon: integer (int64)
  Title: Planning Horizon in Days

  Value that specifies the number of days over which demand is considered by backlog plan.
• CalculateConstraint: integer
  Title: Display constraints for configure-to-order items, shipment sets, and arrival sets

  Value that indicates whether the constraints for configure-to-order and sets order will be calculated by the backlog plan.
• CategorySetId: integer
  Value that uniquely identifies the category set.
• CategorySetName: string
  Title: Category Set

  Read Only: true

  Maximum Length: 255

  Name of the category set specified in backlog planning option.
• ConfigurationId: integer (int64)
  Value that uniquely identifies the backlog plan run.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who initially created the backlog planning options.
• CreationDate: string (date-time)
  Read Only: true

  Date when user created the backlog planning options.
• DaysPastdue: integer
  Title: Past-Due Supply and Demand Considered in Days

  Value that determines which past due supplies and demands are considered in the backlog plan.
• DefaultAssignmentSetId: integer
  Value that uniquely identifies the assignment set.
• DefaultAssignmentSetName: string
  Title: Assignment Set Name

  Maximum Length: 255

  Name of the assignment set used.
• DefaultPriorityRuleId: integer
  Value that uniquely identifies the demand priority rule.
• DefaultPriorityRuleName: string
  Title: Demand Priority Rule

  Maximum Length: 255

  Name of the default priority rule that's used in planning demands in backlog management.
• DemFulfilLeadTime: integer
  Title: Default Demand Fulfillment Lead Time in Days

  Value that specifies the default lead time that's used to determine the fulfillment lead time date on demands.
• HorizonStart: string (date-time)
  Title: Horizon Start Date

  Date that signifies the start of the planning horizon and is typically defaulted to the system date.
• LastBaselineHorizonStart: string (date-time)
  Date that indicates the start of planning horizon for previous base line plan run.
• links: array Links
  Title: Links

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

  Text of the error message, if any, encountered when creating or updating the backlog planning options.
• SupplyPlan: string
  Title: Supply Plans

  Maximum Length: 4000

  Values of the supply plan unique identifiers or the plan ID that are used as supply schedules in backlog management.
• SupplyPlanName: string
  Maximum Length: 255

  Names of the supply plans that are used as supply schedules in backlog management.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when user created the backlog planning options.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculateConstraint":{
            "title":"Display constraints for configure-to-order items, shipment sets, and arrival sets",
            "type":"integer",
            "description":"Value that indicates whether the constraints for configure-to-order and sets order will be calculated by the backlog plan.",
            "nullable":true,
            "x-queryable":true
        },
        "HorizonStart":{
            "title":"Horizon Start Date",
            "type":"string",
            "description":"Date that signifies the start of the planning horizon and is typically defaulted to the system date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who initially created the backlog planning options.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":"255",
            "type":"string",
            "description":"Text of the error message, if any, encountered when creating or updating the backlog planning options.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPriorityRuleName":{
            "title":"Demand Priority Rule",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the default priority rule that's used in planning demands in backlog management.",
            "nullable":true,
            "x-queryable":true
        },
        "LastBaselineHorizonStart":{
            "type":"string",
            "description":"Date that indicates the start of planning horizon for previous base line plan run.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultPriorityRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand priority rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultAssignmentSetName":{
            "title":"Assignment Set Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the assignment set used.",
            "nullable":true,
            "x-queryable":true
        },
        "DemFulfilLeadTime":{
            "title":"Default Demand Fulfillment Lead Time in Days",
            "type":"integer",
            "description":"Value that specifies the default lead time that's used to determine the fulfillment lead time date on demands.",
            "nullable":true,
            "x-queryable":true
        },
        "BucketsPerHorizon":{
            "title":"Planning Horizon in Days",
            "type":"integer",
            "description":"Value that specifies the number of days over which demand is considered by backlog plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog plan run.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "SupplyPlan":{
            "title":"Supply Plans",
            "maxLength":"4000",
            "type":"string",
            "description":"Values of the supply plan unique identifiers or the plan ID that are used as supply schedules in backlog management.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategorySetName":{
            "title":"Category Set",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the category set specified in backlog planning option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultAssignmentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assignment set.",
            "nullable":true,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set.",
            "nullable":true,
            "x-queryable":true
        },
        "DaysPastdue":{
            "title":"Past-Due Supply and Demand Considered in Days",
            "type":"integer",
            "description":"Value that determines which past due supplies and demands are considered in the backlog plan.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyPlanName":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the supply plans that are used as supply schedules in backlog management.",
            "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 : 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

Examples

This example describes how to create backlog planning options.

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/backlogPlanningOptions"

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.

{
"BucketsPerHorizon": 90,
"CalculateConstraint": 1,
"CategorySetId": 10154,
"ConfigurationId": -1,
"DaysPastdue": 10,
"DemFulfilLeadTime": 10,
"HorizonStart": null,
"SupplyPlanName": "BLM_RT-SP-INT",
"DefaultAssignmentSetName": "BLM_ASET_DEFAULT",
"DefaultPriorityRuleName": "Default_reqdate_revenue"
}

Example Response Body

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

{
    "BucketsPerHorizon": 90,
    "CalculateConstraint": 1,
    "CategorySetId": 10154,
    "ConfigurationId": -1,
    "CreatedBy": "BLM_ALL",
    "CreationDate": "2024-06-18T08:15:58+00:00",
    "DaysPastdue": 10,
    "DefaultAssignmentSetId": 100000012037099,
    "DefaultPriorityRuleId": 300100178581705,
    "DemFulfilLeadTime": 10,
    "HorizonStart": null,
    "LastBaselineHorizonStart": null,
    "SupplyPlan": "300100550649238",
    "SupplyPlanName": "BLM_RT-SP-INT",
    "DefaultAssignmentSetName": "BLM_ASET_DEFAULT",
    "DefaultPriorityRuleName": "Default_reqdate_revenue",
    "CategorySetName": "GOP_Catalog",
    "Message": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1",
            "name": "backlogPlanningOptions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1",
            "name": "backlogPlanningOptions",
            "kind": "item"
        }
    ]
}

Back to Top