Jump to

• Request
• Response
• Examples

Get one demand

get

/fscmRestApi/resources/11.13.18.05/backlogManagementPlans/{BmRunId}/child/demands/{DemandId}

Request

Path Parameters

• BmRunId(required): integer
  Value that uniquely identifies the backlog management plan run.
• DemandId(required): integer
  Value that uniquely identifies a demand within a backlog management plan run.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : backlogManagementPlans-demands-item-response

Type: object

Show Source

• AllowSplitsIndicator: integer
  Read Only: true

  Value that indicates whether the demand can be split for fulfillment or not.
• ArrivalSetName: string
  Maximum Length: 30

  Value that uniquely identifies the fulfillment line arrival set.
• BmRunId: integer
  Read Only: true

  Value that uniquely identifies the backlog management plan run.
• CarrierId: integer (int64)
  Value that uniquely identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• CarrierName: string
  Maximum Length: 255

  Value that identifies the carrier from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
• ConfiguredItem: string
  Maximum Length: 1200

  Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands.
• ConstraintRank: integer
  Read Only: true

  Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the demand.
• CustomerId: integer (int64)
  Value that uniquely identifies the customer on the demand.
• CustomerName: string
  Maximum Length: 255

  Name of the customer on the demand.
• CustomerPurchOrderLineNumber: string
  Maximum Length: 50

  Number that identifies the purchase order line that's reserved against the drop ship sales order. This attribute is for future use.
• CustomerPurchOrderNumber: string
  Maximum Length: 240

  Number that identifies the purchase order that's reserved against the drop ship sales order. This attribute is for future use.
• CustomerPurchOrderScheduleNumber: string
  Maximum Length: 50

  Value that identifies the purchase order schedule that's reserved against the drop ship sales order. This attribute is for future use.
• CustomerSiteId: integer (int64)
  Value that uniquely identifies the customer site of the demand.
• CustomerSiteName: string
  Maximum Length: 255

  Name of the customer site on the demand.
• DaysPotentiallyImprove: integer
  Read Only: true

  Value that identifies the number of days by which the planned date will improve if all items with a constraint rank higher than or equal to this item's constraint rank are removed.
• DemandClass: string
  Maximum Length: 34

  Name of the demand class on the demand.
• DemandFulfillmentLeadTime: integer
  Value that indicates the delivery lead time that you enter on the fulfillment line.
• DemandId: integer
  Value that uniquely identifies a demand within a backlog management plan run.
• DemandLeadTimeDate: string (date)
  Date that corresponds to the lead time available to fulfill the demand.
• DemandPriority: integer
  Priority of a demand within the backlog management plan run.
• DemandQuantity: number
  Read Only: true

  Quantity of the demand fulfilled in the split demand.
• EarliestAcceptableDate: string (date)
  Earliest date that's acceptable on the fulfillment line.
• EarliestPromisedDate: string (date)
  Date when the item can be available.
• EccIndicator: integer
  Contains one of the following values: Yes or No. If Yes, then the existing scheduled information on the demand must be respected when planning the demand. If No, then the existing commitments can be ignored. The default value is Yes.
• ErrorText: string
  Read Only: true

  Maximum Length: 255

  Textual description for an error that the backlog planner encountered while planning for a demand line.
• ESSJobId: integer
  Value that uniquely identifies the process that updates the demand attribute's data.
• ExpectedArrivalDate: string (date)
  Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization.
• ExpectedCarrierId: integer (int64)
  Value that uniquely identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ExpectedCarrierName: string
  Maximum Length: 255

  Value that identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ExpectedModeOfTransport: integer (int64)
  Value that uniquely identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
• ExpectedModeOfTransportName: string
  Maximum Length: 255

  Value that identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
• ExpectedServiceLevel: integer (int64)
  Value that uniquely identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ExpectedServiceLevelName: string
  Maximum Length: 255

  Value that identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ExpectedShipDate: string (date)
  Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.
• ExpectedShipMethod: string
  Maximum Length: 30

  Value that identifies the planned shipping method from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ExpectedSupplierId: integer (int64)
  Value that identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
• ExpectedSupplierName: string
  Maximum Length: 255

  Name of the planned drop ship supplier from where material is to be shipped to the customer ship-to site.
• ExpectedSupplierSiteId: integer (int64)
  Value that identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
• ExpectedSupplierSiteName: string
  Maximum Length: 255

  Name of the planned drop ship supplier site from where material is to be shipped to the customer ship-to site.
• FirmArrivalSetName: string
  Maximum Length: 30

  Value that indicates the user-specified arrival set on the demand.
• FirmOrganizationName: string
  Maximum Length: 255

  Name of the user-specified organization from which the item will be planned.
• FirmSalesOrder: integer
  Value that indicates whether a demand has been locked or not.
• FirmShipFromOrg: integer (int64)
  Value that indicates the user-specified organization on the demand.
• FirmShipSetName: string
  Maximum Length: 30

  Value that indicates the user-specified shipment set on the demand.
• FulfillmentLineNumber: integer
  Number that uniquely identifies the fulfillment line.
• InventoryItemId: integer
  Value that uniquely identifies the item that's requested on the demand.
• InventoryItemName: string
  Maximum Length: 255

  Name of the item requested on the demand.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the demand.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the demand.
• LatestAcceptableDate: string (date)
  Last date that's acceptable on the fulfillment line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualOverrideIndicator: integer (int32)
  Value that indicates whether the planned information on the demand has been manually overridden.
• MarkedForRelease: integer (int32)
  Value that indicates whether the demand has been identified for release to order management.
• Message: string
  Maximum Length: 255

  Message that indicates the success or failure of the bulk upload of the demand attributes.
• ModeOfTransport: integer (int64)
  Value that uniquely identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
• ModeOfTransportName: string
  Maximum Length: 255

  Value that identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.
• NewPromisedDate: string (date)
  Date when the demand is planned in the backlog management plan.
• OldPromisedDate: string (date)
  Date when the demand was originally scheduled.
• OrchOrderLineNumber: string
  Maximum Length: 50

  Number that uniquely identifies the orchestration line in Oracle Order Management Cloud for a demand.
• OrchOrderNumber: string
  Maximum Length: 50

  Number that uniquely identifies the orchestration in Oracle Order Management Cloud for a demand.
• OrderDateTypeCode: integer
  Value that indicates whether the request is the arrival date or ship date type. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively.
• OrderLineStatus: number
  Read Only: true

  Status of the sales order line that indicates whether an order is in picked, shipped, or in any other status. The order lines that are in the picked, shipped, or canceled status aren't released.
• OrderNumber: string
  Maximum Length: 240

  Number that uniquely identifies the sales order for which the fulfillment line is created.
• OrderRevenue: integer
  Revenue from the demand.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization from which an item is requested.
• OrganizationId: integer
  Value that uniquely identifies the organization from which an item is requested.
• OrganizationName: string
  Maximum Length: 255

  Name of the organization from which an item is requested.
• OriginationType: integer
  Type of demand. Values include Sales Order demand or Simulation demand.
• OverridePriority: integer
  Manually overridden priority on a demand.
• ParentFulfillmentLine: string
  Maximum Length: 400

  Value that uniquely identifies the fulfillment line for the immediate parent item in a configure-to-order item structure.
• PlannedDateWithoutItem: string (date)
  Read Only: true

  Date when the configure to order item order or set order can be fulfilled, if all items with a constraint rank higher than or equal to this item's constraint rank are removed.
• PromisedQuantity: integer
  Quantity planned in case a demand is partially fulfilled.
• PullInIndicator: integer
  Contains one of the following values: Yes or No. If Yes, then the order can be planned earlier than its current Scheduled date until its Requested Date. If No, then the order can't be planned earlier than its existing Scheduled Date. The default value is Yes.
• ReasonCode: integer
  Value that indicates the reason why the demand wasn't planned.
• ReleaseStatus: integer
  Value that indicates the release status. Values include Release, Released, Marked for Release, or blank. If Release, then the demand is eligible for release to the order management application. If Marked for Release, then the demand has been confirmed to be released to the order management application. If Released, then the line has already been released to order management.
• RequestedDate: string (date)
  Date when the material is requested to be available. Depending on the order date type code this attribute represents the requested ship date or the requested arrival date.
• RequestedDateQuantity: integer
  Quantity available on the requested date.
• RootFulfillmentLine: string
  Maximum Length: 400

  Value that uniquely identifies the fulfillment line for the end item in a configure-to-order item structure.
• SalesOrderNumber: string
  Read Only: true

  Maximum Length: 240

  Number that uniquely identifies the sales order for the demand.
• ServiceLevel: integer (int64)
  Value that uniquely identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ServiceLevelName: string
  Maximum Length: 255

  Value that identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.
• ShipMethod: string
  Maximum Length: 30

  Shipping method used to ship the requested item line from the ship-from organization to the customer ship-to site.
• ShipSetName: string
  Maximum Length: 30

  Value that uniquely identifies the fulfillment line shipment set.
• SoLineNumber: string
  Read Only: true

  Maximum Length: 150

  Number that uniquely identifies the sales order line for the demand.
• SourceOrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the source organization from which an item is planned.
• SourceOrganizationId: integer
  Value that uniquely identifies the source organization on the demand.
• SourceOrganizationName: string
  Maximum Length: 255

  Name of the source organization from which an item is requested.
• SplitFromDemandId: integer (int64)
  Value that uniquely identifies the demand from which the current demand was split for fulfillment.
• SupplierId: integer (int64)
  Value that uniquely identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.
• SupplierName: string
  Maximum Length: 255

  Name of the drop ship supplier from where material is to be shipped to the customer ship-to site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.
• SupplierSiteName: string
  Maximum Length: 255

  Name of the drop ship supplier site from where material is to be shipped to the customer ship-to site.
• SupplyPickDate: string (date)
  Date to pick and pack the item that's to be shipped from the warehouse.
• UpdateAsync: string (byte)
  Encoded demand data used when updating the demand attribute's data in bulk.
• UpdateMode: string
  Maximum Length: 255

  Mode that indicates whether the demand attribute's data is updated using the bulk update process.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the demand.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchOrderNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that uniquely identifies the orchestration in Oracle Order Management Cloud for a demand.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmArrivalSetName":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the user-specified arrival set on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipSetName":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line shipment set.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedDateQuantity":{
            "type":"integer",
            "description":"Quantity available on the requested date.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateMode":{
            "maxLength":255,
            "type":"string",
            "description":"Mode that indicates whether the demand attribute's data is updated using the bulk update process.",
            "nullable":true,
            "x-queryable":true
        },
        "RootFulfillmentLine":{
            "maxLength":400,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line for the end item in a configure-to-order item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source organization from which an item is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number that uniquely identifies the sales order for which the fulfillment line is created.",
            "nullable":true,
            "x-queryable":true
        },
        "SoLineNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that uniquely identifies the sales order line for the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldPromisedDate":{
            "type":"string",
            "description":"Date when the demand was originally scheduled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseStatus":{
            "type":"integer",
            "description":"Value that indicates the release status. Values include Release, Released, Marked for Release, or blank. If Release, then the demand is eligible for release to the order management application. If Marked for Release, then the demand has been confirmed to be released to the order management application. If Released, then the line has already been released to order management.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestedDate":{
            "type":"string",
            "description":"Date when the material is requested to be available. Depending on the order date type code this attribute represents the requested ship date or the requested arrival date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the demand.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the carrier from the source inventory organization to destination inventory organization that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the demand.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "maxLength":255,
            "type":"string",
            "description":"Textual description for an error that the backlog planner encountered while planning for a demand line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that's requested on the demand.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer on the demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ArrivalSetName":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line arrival set.",
            "nullable":true,
            "x-queryable":true
        },
        "PullInIndicator":{
            "type":"integer",
            "description":"Contains one of the following values: Yes or No. If Yes, then the order can be planned earlier than its current Scheduled date until its Requested Date. If No, then the order can't be planned earlier than its existing Scheduled Date. The default value is Yes.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number that uniquely identifies the sales order for the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site of the demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ModeOfTransport":{
            "type":"integer",
            "description":"Value that uniquely identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerPurchOrderNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number that identifies the purchase order that's reserved against the drop ship sales order. This attribute is for future use.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedSupplierSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the planned drop ship supplier site from where material is to be shipped to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyPickDate":{
            "type":"string",
            "description":"Date to pick and pack the item that's to be shipped from the warehouse.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedModeOfTransport":{
            "type":"integer",
            "description":"Value that uniquely identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarliestPromisedDate":{
            "type":"string",
            "description":"Date when the item can be available.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OverridePriority":{
            "type":"integer",
            "description":"Manually overridden priority on a demand.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier site from where material is to be shipped to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "DaysPotentiallyImprove":{
            "type":"integer",
            "description":"Value that identifies the number of days by which the planned date will improve if all items with a constraint rank higher than or equal to this item's constraint rank are removed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerPurchOrderScheduleNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Value that identifies the purchase order schedule that's reserved against the drop ship sales order. This attribute is for future use.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the item requested on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpectedSupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the planned drop ship supplier from where material is to be shipped to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginationType":{
            "type":"integer",
            "description":"Type of demand. Values include Sales Order demand or Simulation demand.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization from which an item is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "MarkedForRelease":{
            "type":"integer",
            "description":"Value that indicates whether the demand has been identified for release to order management.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source organization on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "FulfillmentLineNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedModeOfTransportName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the planned transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandQuantity":{
            "type":"number",
            "description":"Quantity of the demand fulfilled in the split demand.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConstraintRank":{
            "type":"integer",
            "description":"Value that identifies the item constraint ranking based on the difference between their respective item availability dates and requested dates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderRevenue":{
            "type":"integer",
            "description":"Revenue from the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process that updates the demand attribute's data.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClass":{
            "maxLength":34,
            "type":"string",
            "description":"Name of the demand class on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentFulfillmentLine":{
            "maxLength":400,
            "type":"string",
            "description":"Value that uniquely identifies the fulfillment line for the immediate parent item in a configure-to-order item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the demand.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Shipping method used to ship the requested item line from the ship-from organization to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedSupplierId":{
            "type":"integer",
            "description":"Value that identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandFulfillmentLeadTime":{
            "type":"integer",
            "description":"Value that indicates the delivery lead time that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateAsync":{
            "type":"string",
            "description":"Encoded demand data used when updating the demand attribute's data in bulk.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ModeOfTransportName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the transport mode from the source inventory organization to destination inventory organization that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannedDateWithoutItem":{
            "type":"string",
            "description":"Date when the configure to order item order or set order can be fulfilled, if all items with a constraint rank higher than or equal to this item's constraint rank are removed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirmShipFromOrg":{
            "type":"integer",
            "description":"Value that indicates the user-specified organization on the demand.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EccIndicator":{
            "type":"integer",
            "description":"Contains one of the following values: Yes or No. If Yes, then the existing scheduled information on the demand must be respected when planning the demand. If No, then the existing commitments can be ignored. The default value is Yes.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedCarrierName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FirmSalesOrder":{
            "type":"integer",
            "description":"Value that indicates whether a demand has been locked or not.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestAcceptableDate":{
            "type":"string",
            "description":"Last date that's acceptable on the fulfillment line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedArrivalDate":{
            "type":"string",
            "description":"Date when the requested item line is expected to arrive at the customer ship-to site from the ship-from organization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedSupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the drop ship supplier site from where material is to be shipped to the customer ship-to site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandLeadTimeDate":{
            "type":"string",
            "description":"Date that corresponds to the lead time available to fulfill the demand.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonCode":{
            "type":"integer",
            "description":"Value that indicates the reason why the demand wasn't planned.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the drop ship supplier from where material is to be shipped to the customer ship-to site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the source organization from which an item is planned.",
            "nullable":true,
            "x-queryable":true
        },
        "ManualOverrideIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the planned information on the demand has been manually overridden.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PromisedQuantity":{
            "type":"integer",
            "description":"Quantity planned in case a demand is partially fulfilled.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandPriority":{
            "type":"integer",
            "description":"Priority of a demand within the backlog management plan run.",
            "nullable":true,
            "x-queryable":true
        },
        "EarliestAcceptableDate":{
            "type":"string",
            "description":"Earliest date that's acceptable on the fulfillment line.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpectedServiceLevel":{
            "type":"integer",
            "description":"Value that uniquely identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization from which an item is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPurchOrderLineNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the purchase order line that's reserved against the drop ship sales order. This attribute is for future use.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchOrderLineNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Number that uniquely identifies the orchestration line in Oracle Order Management Cloud for a demand.",
            "nullable":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"Message that indicates the success or failure of the bulk upload of the demand attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedCarrierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planned carrier from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies a demand within a backlog management plan run.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization from which an item is requested.",
            "nullable":false,
            "x-queryable":true
        },
        "NewPromisedDate":{
            "type":"string",
            "description":"Date when the demand is planned in the backlog management plan.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SplitFromDemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand from which the current demand was split for fulfillment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpectedServiceLevelName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the planned service level used for shipping from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowSplitsIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the demand can be split for fulfillment or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineStatus":{
            "type":"number",
            "description":"Status of the sales order line that indicates whether an order is in picked, shipped, or in any other status. The order lines that are in the picked, shipped, or canceled status aren't released.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedShipDate":{
            "type":"string",
            "description":"Date when the requested item line is expected to be shipped from the ship-from organization to the customer ship-to site.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrderDateTypeCode":{
            "type":"integer",
            "description":"Value that indicates whether the request is the arrival date or ship date type. Depending on the request type, the requested date represents the requested ship date and requested arrival date respectively.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfiguredItem":{
            "maxLength":1200,
            "type":"string",
            "description":"Value that identifies the unique configuration item corresponding to the configuration sent for promising. This attribute is applicable only in the case of assemble to order demands.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the planned shipping method from the ship-from organization to the customer ship-to site that you enter on the fulfillment line.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the drop ship supplier from where material is to be shipped to the customer ship-to site.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the customer site on the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user-specified organization from which the item will be planned.",
            "nullable":true,
            "x-queryable":true
        },
        "FirmShipSetName":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the user-specified shipment set on the demand.",
            "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 get one demand from the backlog management plan.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/backlogManagementPlans/BmRunId/child/demands/DemandId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/demands/4322750"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "BmRunId": -1,
  "DemandId": 4322750,
  "DemandPriority": null,
  "InventoryItemId": 10262,
  "OrganizationId": 10001,
  "OldPromisedDate": "2022-05-16",
  "NewPromisedDate": null,
  "RequestedDate": "2022-05-16",
  "CreatedBy": "SCMOPERATIONS",
  "CreationDate": "2022-05-16T19:48:27.750+00:00",
  "LastUpdatedBy": "SCMOPERATIONS",
  "LastUpdateDate": "2022-05-16T19:48:27.750+00:00",
  "LastUpdateLogin": "DF25EF1AAAE520B4E0532D06F10A5D85",
  "CustomerId": 300100004591330,
  "CustomerSiteId": 300100004591336,
  "DemandClass": null,
  "SourceOrganizationId": null,
  "FirmSalesOrder": 2,
  "FirmShipFromOrg": null,
  "FirmShipSetName": null,
  "FirmArrivalSetName": null,
  "EarliestPromisedDate": null,
  "ExpectedShipDate": null,
  "ExpectedArrivalDate": null,
  "ShipMethod": null,
  "ShipSetName": "S1",
  "ArrivalSetName": null,
  "CarrierId": 32512,
  "ModeOfTransport": 36,
  "ServiceLevel": 821,
  "SplitFromDemandId": null,
  "SupplierId": null,
  "SupplierSiteId": null,
  "EccIndicator": 1,
  "RequestedDateQuantity": null,
  "PullInIndicator": 1,
  "MarkedForRelease": null,
  "OrderRevenue": 0,
  "AllowSplitsIndicator": 2,
  "ManualOverrideIndicator": 2,
  "ExpectedSupplierId": null,
  "ExpectedSupplierSiteId": null,
  "ExpectedShipMethod": null,
  "ExpectedCarrierId": null,
  "ExpectedModeOfTransport": null,
  "ExpectedServiceLevel": null,
  "OverridePriority": null,
  "ReasonCode": null,
  "DemandFulfillmentLeadTime": null,
  "EarliestAcceptableDate": null,
  "LatestAcceptableDate": null,
  "OriginationType": 1030,
  "ConfiguredItem": null,
  "OrderDateTypeCode": 1,
  "OrderNumber": "1652724849301",
  "PromisedQuantity": null,
  "ReleaseStatus": null,
  "DemandLeadTimeDate": null,
  "SalesOrderNumber": "521420",
  "SoLineNumber": "7.1",
  "FulfillmentLineNumber": 1,
  "OrchOrderNumber": "521420",
  "OrchOrderLineNumber": "7",
  "RootFulfillmentLine": null,
  "ParentFulfillmentLine": null,
  "CustomerPurchOrderScheduleNumber": null,
  "CustomerPurchOrderNumber": null,
  "CustomerPurchOrderLineNumber": null,
  "DemandQuantity": 0,
  "InventoryItemName": "AS54888",
  "OrganizationName": "Seattle Manufacturing",
  "OrganizationCode": "M1",
  "SupplierName": null,
  "SupplierSiteName": null,
  "CustomerName": "Computer Associates International",
  "CustomerSiteName": "300100004591335",
  "ExpectedSupplierName": null,
  "ExpectedSupplierSiteName": null,
  "SourceOrganizationName": null,
  "SourceOrganizationCode": null,
  "FirmOrganizationName": null,
  "CarrierName": "DHL",
  "ModeOfTransportName": "Air",
  "ServiceLevelName": "2nd day air",
  "ExpectedCarrierName": null,
  "ExpectedModeOfTransportName": null,
  "ExpectedServiceLevelName": null,
  "OrderLineStatus": 1,
  "ErrorText": null,
  "ESSJobId": null,
  "Message": null,
  "UpdateMode": null,
  "links": [
    {
      "rel": "self",
      "href": "https://server/fscmRestApi/resources/version/backlogManagementPlans/-1/child/demands/4322750",
      "name": "demands",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "https://server/fscmRestApi/resources/version/backlogManagementPlans/-1/child/demands/4322750",
      "name": "demands",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://server/fscmRestApi/resources/version/backlogManagementPlans/-1",
      "name": "backlogManagementPlans",
      "kind": "item"
    },
    {
      "rel": "enclosure",
      "href": "https://server/fscmRestApi/resources/version/backlogManagementPlans/-1/child/demands/4322750/enclosure/UpdateAsync",
      "name": "UpdateAsync",
      "kind": "other"
    }
  ]
}

Back to Top