Jump to

• Request
• Response

Update one pan cluster demand and supply

patch

/fscmRestApi/resources/11.13.18.05/planOptions/{PlanId}/child/PlanClusterDmdSup/{PlanId2}

Request

Path Parameters

• PlanId(required): integer(int64)
  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=
• PlanId2(required): integer(int64)
  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

• 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

• GrossForecast: integer (int32)
  Indicates whether gross forecast is included while calculating inventory excesses and shortages. The valid values are Yes or No.
• IntransitShipments: integer (int32)
  Value for a replenishment plan that determines whether in-transit shipments are included during the calculation of inventory excesses and shortages.
• ManualDemand: integer (int32)
  Indicates whether the manual demand is included while calculating inventory excesses and shortages.
• MovementRequestDemand: integer (int32)
  Indicates whether the movement request demand is included while calculating inventory excesses and shortages.
• MovementRequests: integer (int32)
  Value for a replenishment plan. When this attribute is selected, movement requests are included while calculating inventory excesses and shortages.
• NetForecast: integer (int32)
  Indicates whether net forecasts are considered in inventory rebalance calculations. The valid values are Yes or No.
• OnHand: integer (int32)
  Indicates whether on-hand quantity is considered in inventory rebalance calculations. The possible values are Yes or No.
• PlanId: integer (int64)
  Uniquely identifies the plan.
• PlannedInboundShipments: integer (int32)
  Value of a replenishment plan. When this attribute is selected, planned inbound shipments are included during the calculation of inventory excesses and shortages.
• PlannedOutboundShipments: integer (int32)
  Indicates whether the planned outbound shipments are included while calculating inventory excesses and shortages.
• PurchaseOrder: integer (int32)
  Value of a replenishment plan. When this attribute is selected, purchase orders are included while calculating inventory excesses and shortages.
• PurchaseRequisition: integer (int32)
  Value that indicates whether purchase requisitions are included while calculating inventory excesses and shortages.
• SalesOrder: integer (int32)
  Indicates whether sales orders are included while calculating inventory excesses and shortages.
• ShipmentInReceiving: integer (int32)
  Indicates whether the shipments in receiving are included while calculating inventory excesses and shortages.
• TransferOrder: integer (int32)
  Value that indicates whether transfer orders are included while calculating inventory excesses and shortages.
• TransferOrderDemand: integer (int32)
  Indicates whether the transfer order demand is included during the calculation of inventory excesses and shortages. The possible values are Yes or No.

{
    "type":"object",
    "properties":{
        "PurchaseRequisition":{
            "type":"integer",
            "description":"Value that indicates whether purchase requisitions are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "ShipmentInReceiving":{
            "type":"integer",
            "description":"Indicates whether the shipments in receiving are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IntransitShipments":{
            "type":"integer",
            "description":"Value for a replenishment plan that determines whether in-transit shipments are included during the calculation of inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "MovementRequestDemand":{
            "type":"integer",
            "description":"Indicates whether the movement request demand is included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "PlannedInboundShipments":{
            "type":"integer",
            "description":"Value of a replenishment plan. When this attribute is selected, planned inbound shipments are included during the calculation of inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "NetForecast":{
            "type":"integer",
            "description":"Indicates whether net forecasts are considered in inventory rebalance calculations. The valid values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "OnHand":{
            "type":"integer",
            "description":"Indicates whether on-hand quantity is considered in inventory rebalance calculations. The possible values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "TransferOrder":{
            "type":"integer",
            "description":"Value that indicates whether transfer orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "MovementRequests":{
            "type":"integer",
            "description":"Value for a replenishment plan. When this attribute is selected, movement requests are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "PlannedOutboundShipments":{
            "type":"integer",
            "description":"Indicates whether the planned outbound shipments are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "PurchaseOrder":{
            "type":"integer",
            "description":"Value of a replenishment plan. When this attribute is selected, purchase orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "ManualDemand":{
            "type":"integer",
            "description":"Indicates whether the manual demand is included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "GrossForecast":{
            "type":"integer",
            "description":"Indicates whether gross forecast is included while calculating inventory excesses and shortages. The valid values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "SalesOrder":{
            "type":"integer",
            "description":"Indicates whether sales orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "TransferOrderDemand":{
            "type":"integer",
            "description":"Indicates whether the transfer order demand is included during the calculation of inventory excesses and shortages. The possible values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        }
    }
}

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 : planOptions-PlanClusterDmdSup-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the plan cluster.
• CreationDate: string (date-time)
  Read Only: true

  Date when the plan cluster was originally created.
• GrossForecast: integer (int32)
  Indicates whether gross forecast is included while calculating inventory excesses and shortages. The valid values are Yes or No.
• IntransitShipments: integer (int32)
  Value for a replenishment plan that determines whether in-transit shipments are included during the calculation of inventory excesses and shortages.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the plan cluster.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the most recent update on the plan cluster.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last time the user logged into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualDemand: integer (int32)
  Indicates whether the manual demand is included while calculating inventory excesses and shortages.
• MovementRequestDemand: integer (int32)
  Indicates whether the movement request demand is included while calculating inventory excesses and shortages.
• MovementRequests: integer (int32)
  Value for a replenishment plan. When this attribute is selected, movement requests are included while calculating inventory excesses and shortages.
• NetForecast: integer (int32)
  Indicates whether net forecasts are considered in inventory rebalance calculations. The valid values are Yes or No.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Plan cluster version number.
• OnHand: integer (int32)
  Indicates whether on-hand quantity is considered in inventory rebalance calculations. The possible values are Yes or No.
• PlanId: integer (int64)
  Uniquely identifies the plan.
• PlannedInboundShipments: integer (int32)
  Value of a replenishment plan. When this attribute is selected, planned inbound shipments are included during the calculation of inventory excesses and shortages.
• PlannedOutboundShipments: integer (int32)
  Indicates whether the planned outbound shipments are included while calculating inventory excesses and shortages.
• PurchaseOrder: integer (int32)
  Value of a replenishment plan. When this attribute is selected, purchase orders are included while calculating inventory excesses and shortages.
• PurchaseRequisition: integer (int32)
  Value that indicates whether purchase requisitions are included while calculating inventory excesses and shortages.
• SalesOrder: integer (int32)
  Indicates whether sales orders are included while calculating inventory excesses and shortages.
• ShipmentInReceiving: integer (int32)
  Indicates whether the shipments in receiving are included while calculating inventory excesses and shortages.
• TransferOrder: integer (int32)
  Value that indicates whether transfer orders are included while calculating inventory excesses and shortages.
• TransferOrderDemand: integer (int32)
  Indicates whether the transfer order demand is included during the calculation of inventory excesses and shortages. The possible values are Yes or No.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the most recent update on the plan cluster.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the plan cluster was originally created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseRequisition":{
            "type":"integer",
            "description":"Value that indicates whether purchase requisitions are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ShipmentInReceiving":{
            "type":"integer",
            "description":"Indicates whether the shipments in receiving are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the plan cluster.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Uniquely identifies the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IntransitShipments":{
            "type":"integer",
            "description":"Value for a replenishment plan that determines whether in-transit shipments are included during the calculation of inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "MovementRequestDemand":{
            "type":"integer",
            "description":"Indicates whether the movement request demand is included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PlannedInboundShipments":{
            "type":"integer",
            "description":"Value of a replenishment plan. When this attribute is selected, planned inbound shipments are included during the calculation of inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "NetForecast":{
            "type":"integer",
            "description":"Indicates whether net forecasts are considered in inventory rebalance calculations. The valid values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "OnHand":{
            "type":"integer",
            "description":"Indicates whether on-hand quantity is considered in inventory rebalance calculations. The possible values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "TransferOrder":{
            "type":"integer",
            "description":"Value that indicates whether transfer orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "MovementRequests":{
            "type":"integer",
            "description":"Value for a replenishment plan. When this attribute is selected, movement requests are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Plan cluster version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlannedOutboundShipments":{
            "type":"integer",
            "description":"Indicates whether the planned outbound shipments are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PurchaseOrder":{
            "type":"integer",
            "description":"Value of a replenishment plan. When this attribute is selected, purchase orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ManualDemand":{
            "type":"integer",
            "description":"Indicates whether the manual demand is included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "GrossForecast":{
            "type":"integer",
            "description":"Indicates whether gross forecast is included while calculating inventory excesses and shortages. The valid values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the plan cluster.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last time the user logged into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrder":{
            "type":"integer",
            "description":"Indicates whether sales orders are included while calculating inventory excesses and shortages.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "TransferOrderDemand":{
            "type":"integer",
            "description":"Indicates whether the transfer order demand is included during the calculation of inventory excesses and shortages. The possible values are Yes or No.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "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