1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Supply Chain Planning
  4. Backlog Planning Options

Update one backlog planning option

patch

/fscmRestApi/resources/11.13.18.05/backlogPlanningOptions/{ConfigurationId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Scheduling Diagnostic Attributes
Type: array
Title: Scheduling Diagnostic Attributes
The configurations used to enable the scheduling diagnostics and also set the attribute to calculate scheduling diagnostics for the order lines corresponding to the preconfigured attribute values.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Scheduling Diagnostic Attribute Details
Type: array
Title: Scheduling Diagnostic Attribute Details
Attribute values for the attributes specified in scheduling diagnostics.
Show Source
Nested Schema : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Nested Schema : Scheduling Diagnostic Attributes
Type: array
Title: Scheduling Diagnostic Attributes
The configurations used to enable the scheduling diagnostics and also set the attribute to calculate scheduling diagnostics for the order lines corresponding to the preconfigured attribute values.
Show Source
Nested Schema : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-item-response
Type: object
Show Source
Nested Schema : Scheduling Diagnostic Attribute Details
Type: array
Title: Scheduling Diagnostic Attribute Details
Attribute values for the attributes specified in scheduling diagnostics.
Show Source
Nested Schema : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.
  • Read Only: true
    Maximum Length: 255
    Value specified for an attribute in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Value that uniquely identifies the selected attribute's value based on the value identifier in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Maximum Length: 64
    Name of the user who initially created the attribute details in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Date when the user created the attribute details in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Date when the user most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Maximum Length: 64
    The user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
  • Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
  • Links
  • Read Only: true
    Used to implement optimistic locking for attribute details, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.
  • Read Only: true
    Maximum Length: 64
    Value that uniquely identifies the selected attribute's value for attribute details, based on the value identifier in the scheduling diagnostics section of backlog planning options.
Links
scpSchedulingDiagnosticsAttributes
Parameters:
  • ConfigurationId: $request.path.ConfigurationId
The configurations used to enable the scheduling diagnostics and also set the attribute to calculate scheduling diagnostics for the order lines corresponding to the preconfigured attribute values.
Back to Top

Examples

This example describes how to update one backlog planning option.

Example cURL Command

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

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/ConfigurationId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/backlogPlanningOptions/-1"

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 updates. 

{
"BucketsPerHorizon": 360
}

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "BucketsPerHorizon": 360,
    "CalculateConstraint": 1,
    "CategorySetId": 10154,
    "ConfigurationId": -1,
    "CreatedBy": "BLM_ALL",
    "CreationDate": "2019-03-27T09:14:04+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