Jump to

• Request
• Response

Get details of all forecast consumption

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ForecastConsumptionDetails

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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Item for which forecasts have been consumed by sales orders.
    Finder Variables
    • ConsumedItemId; integer; Item for which forecasts have been consumed by sales orders.
    • ConsumptionSequence; integer; Item for which forecasts have been consumed by sales orders.
    • OrganizationId; integer; Item for which forecasts have been consumed by sales orders.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ConsumedItem; string; Item for which forecasts have been consumed by sales orders.
  • ConsumedItemId; integer; Value that uniquely identifies the item for which forecasts have been consumed by sales orders.
  • ConsumedQuantity; number; Quantity of the forecast that was consumed by the sales order or transfer order demand.
  • ConsumptionDate; string; Date the forecast was consumed.
  • ConsumptionLevelOrAttribute; string; Level or attribute for which consumption finds a matching forecast record. For example, a match made by item and organization, or by using item, organization, and demand class, or by using item, project, and task.
  • ConsumptionSequence; integer; Sequence in which the forecast was consumed by the sales order or transfer order demand.
  • CreatedBy; string; User who created the forecast consumption detail.
  • CreationDate; string; Date when the user created the forecast consumption detail.
  • DemandClass; string; A classification of demand used to track and consume different types of demand.
  • DemandId; integer; Value that uniquely identifies the demand.
  • DemandSchedule; string; Name of the demand plan schedule to consume in a supply plan.
  • ForecastCustomer; string; Name of the customer associated with the forecast.
  • ForecastCustomerSite; string; Name of the customer site associated with the forecast.
  • ForecastDemandId; integer; Value that uniquely identifies the forecast demand.
  • ForecastQuantity; number; The forecast demand for the item in the planning bucket.
  • ForecastRequestedItem; string; Name of the requested item associated with the forecast.
  • ForecastRequestedItemId; integer; Value that uniquely identifies the requested item associated with the forecast.
  • LastUpdateDate; string; Date when the forecast consumption detail was most recently updated.
  • LastUpdatedBy; string; User who most recently updated the forecast consumption detail.
  • OrderType; string; Type of order. For example, a purchase order, a sales order, or a work order.
  • OrderTypeCode; integer; Code used to identify the type of order.
  • OrganizationCode; string; Code used to identify an organization.
  • OrganizationId; integer; Value used to uniquely identify an organization.
  • OrganizationName; string; Name of the organization.
  • PlanningAttributeNumber10; string; Value for the planning attribute number 10 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber11; string; Value for the planning attribute number 11 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber12; string; Value for the planning attribute number 12 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber13; string; Value for the planning attribute number 13 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber14; string; Value for the planning attribute number 14 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber15; string; Value for the planning attribute number 15 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber3; string; Value for the planning attribute number 3 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber4; string; Value for the planning attribute number 4 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber5; string; Value for the planning attribute number 5 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber6; string; Value for the planning attribute number 6 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber7; string; Value for the planning attribute number 7 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber8; string; Value for the planning attribute number 8 associated with the forecast consumption in attribute-based planning.
  • PlanningAttributeNumber9; string; Value for the planning attribute number 9 associated with the forecast consumption in attribute-based planning.
  • ProjectGroupValue; string; Project group associated with the forecast.
  • ProjectValue; string; Project associated with the forecast.
  • SalesOrTransferOrderItem; string; Name of the item associated with the sales order or transfer order demand.
  • SalesOrTransferOrderLine; string; Identifier for the sales order or transfer order line.
  • SalesOrTransferOrderNumber; string; Order identifier on a sales order or transfer order.
  • SalesOrTransferOrderQuantity; number; Quantity of the sales order or transfer order line.
  • SalesOrderCustomer; string; Name of the customer associated with the sales order.
  • SalesOrderCustomerId; integer; Name of the customer associated with the sales order.
  • SalesOrderCustomerSite; string; Name of the customer site associated with the sales order.
  • SalesOrderPlanningAttributeNumber10; string; Value for the planning attribute number 10 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber11; string; Value for the planning attribute number 11 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber12; string; Value for the planning attribute number 12 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber13; string; Value for the planning attribute number 13 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber14; string; Value for the planning attribute number 14 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber15; string; Value for the planning attribute number 15 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber3; string; Value for the planning attribute number 3 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber4; string; Value for the planning attribute number 4 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber5; string; Value for the planning attribute number 5 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber6; string; Value for the planning attribute number 6 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber7; string; Value for the planning attribute number 7 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber8; string; Value for the planning attribute number 8 associated with the sales or transfer order.
  • SalesOrderPlanningAttributeNumber9; string; Value for the planning attribute number 9 associated with the sales or transfer order.
  • SalesOrderProjectGroupValue; string; Project group associated with the sales or transfer order.
  • SalesOrderProjectValue; string; Project associated with the sales or transfer order.
  • SalesOrderRequestedItem; string; Name of the requested item associated with the sales order.
  • SalesOrderTaskValue; string; Task associated with the sales or transfer order.
  • SalesOrderorTransferOrderOriginalShipDate; string; Original ship date associated with the sales order or transfer order demand.
  • ShipToConsumptionLevel; string; Level or attribute for which consumption finds a matching forecast record. For example, a match made by using only item and organization, or by using item, organization, and demand class, or by using item, project, and task.
  • TaskValue; string; Task associated with the forecast.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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:
  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 : supplyPlans-ForecastConsumptionDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplyPlans-ForecastConsumptionDetails-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyPlans-ForecastConsumptionDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplyPlans-ForecastConsumptionDetails-item-response"
    }
}

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 : supplyPlans-ForecastConsumptionDetails-item-response

Type: object

Show Source

• ConsumedItem: string
  Title: Consumed Item

  Read Only: true

  Maximum Length: 4000

  Item for which forecasts have been consumed by sales orders.
• ConsumedItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item for which forecasts have been consumed by sales orders.
• ConsumedQuantity: number
  Title: Consumed Quantity

  Read Only: true

  Quantity of the forecast that was consumed by the sales order or transfer order demand.
• ConsumptionDate: string (date)
  Title: Consumption Date

  Read Only: true

  Date the forecast was consumed.
• ConsumptionLevelOrAttribute: string
  Title: Consumption Level or Attribute

  Read Only: true

  Maximum Length: 4000

  Level or attribute for which consumption finds a matching forecast record. For example, a match made by item and organization, or by using item, organization, and demand class, or by using item, project, and task.
• ConsumptionSequence: integer (int64)
  Title: Consumption Sequence

  Read Only: true

  Sequence in which the forecast was consumed by the sales order or transfer order demand.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the forecast consumption detail.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the user created the forecast consumption detail.
• DemandClass: string
  Title: Demand Class

  Read Only: true

  Maximum Length: 4000

  A classification of demand used to track and consume different types of demand.
• DemandId: integer (int64)
  Read Only: true

  Value that uniquely identifies the demand.
• DemandSchedule: string
  Title: Demand Schedule

  Read Only: true

  Maximum Length: 4000

  Name of the demand plan schedule to consume in a supply plan.
• ForecastCustomer: string
  Title: Forecast Customer

  Read Only: true

  Maximum Length: 4000

  Name of the customer associated with the forecast.
• ForecastCustomerSite: string
  Title: Forecast Customer Site

  Read Only: true

  Maximum Length: 4000

  Name of the customer site associated with the forecast.
• ForecastDemandId: integer (int64)
  Read Only: true

  Value that uniquely identifies the forecast demand.
• ForecastQuantity: number
  Title: Forecast Quantity

  Read Only: true

  The forecast demand for the item in the planning bucket.
• ForecastRequestedItem: string
  Title: Forecast Requested Item

  Read Only: true

  Maximum Length: 4000

  Name of the requested item associated with the forecast.
• ForecastRequestedItemId: integer
  Read Only: true

  Value that uniquely identifies the requested item associated with the forecast.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the forecast consumption detail was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the forecast consumption detail.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderType: string
  Title: Order Type

  Read Only: true

  Maximum Length: 4000

  Type of order. For example, a purchase order, a sales order, or a work order.
• OrderTypeCode: integer
  Read Only: true

  Code used to identify the type of order.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Code used to identify an organization.
• OrganizationId: integer (int64)
  Read Only: true

  Value used to uniquely identify an organization.
• OrganizationName: string
  Title: Organization Name

  Read Only: true

  Maximum Length: 4000

  Name of the organization.
• PlanningAttributeNumber10: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 10 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber11: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 11 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber12: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 12 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber13: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 13 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber14: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 14 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber15: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 15 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber3: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 3 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber4: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 4 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber5: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 5 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber6: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 6 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber7: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 7 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber8: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 8 associated with the forecast consumption in attribute-based planning.
• PlanningAttributeNumber9: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 9 associated with the forecast consumption in attribute-based planning.
• ProjectGroupValue: string
  Title: Forecast Project Group

  Read Only: true

  Maximum Length: 4000

  Project group associated with the forecast.
• ProjectValue: string
  Title: Forecast Project

  Read Only: true

  Maximum Length: 4000

  Project associated with the forecast.
• SalesOrderCustomer: string
  Title: Sales Order Customer

  Read Only: true

  Maximum Length: 4000

  Name of the customer associated with the sales order.
• SalesOrderCustomerId: integer (int64)
  Read Only: true

  Name of the customer associated with the sales order.
• SalesOrderCustomerSite: string
  Title: Sales Order Customer Site

  Read Only: true

  Maximum Length: 4000

  Name of the customer site associated with the sales order.
• SalesOrderorTransferOrderOriginalShipDate: string (date)
  Title: Sales Order or Transfer Order Original Ship Date

  Read Only: true

  Original ship date associated with the sales order or transfer order demand.
• SalesOrderPlanningAttributeNumber10: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 10 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber11: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 11 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber12: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 12 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber13: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 13 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber14: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 14 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber15: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 15 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber3: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 3 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber4: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 4 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber5: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 5 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber6: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 6 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber7: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 7 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber8: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 8 associated with the sales or transfer order.
• SalesOrderPlanningAttributeNumber9: string
  Read Only: true

  Maximum Length: 4000

  Value for the planning attribute number 9 associated with the sales or transfer order.
• SalesOrderProjectGroupValue: string
  Title: Sales Order or Transfer Order Project Group

  Read Only: true

  Maximum Length: 4000

  Project group associated with the sales or transfer order.
• SalesOrderProjectValue: string
  Title: Sales Order or Transfer Order Project

  Read Only: true

  Maximum Length: 4000

  Project associated with the sales or transfer order.
• SalesOrderRequestedItem: string
  Title: Sales Order Requested Item

  Read Only: true

  Maximum Length: 4000

  Name of the requested item associated with the sales order.
• SalesOrderTaskValue: string
  Title: Sales Order or Transfer Order Task

  Read Only: true

  Maximum Length: 4000

  Task associated with the sales or transfer order.
• SalesOrTransferOrderItem: string
  Title: Sales Order or Transfer Order Item

  Read Only: true

  Maximum Length: 4000

  Name of the item associated with the sales order or transfer order demand.
• SalesOrTransferOrderLine: string
  Title: Sales or Transfer Order Line

  Read Only: true

  Maximum Length: 150

  Identifier for the sales order or transfer order line.
• SalesOrTransferOrderNumber: string
  Title: Sales or Transfer Order Number

  Read Only: true

  Maximum Length: 4000

  Order identifier on a sales order or transfer order.
• SalesOrTransferOrderQuantity: number
  Title: Sales or Transfer Order Quantity

  Read Only: true

  Quantity of the sales order or transfer order line.
• ShipToConsumptionLevel: string
  Title: Ship-to Consumption Level

  Read Only: true

  Maximum Length: 4000

  Level or attribute for which consumption finds a matching forecast record. For example, a match made by using only item and organization, or by using item, organization, and demand class, or by using item, project, and task.
• TaskValue: string
  Title: Forecast Task

  Read Only: true

  Maximum Length: 4000

  Task associated with the forecast.

{
    "type":"object",
    "properties":{
        "ConsumedItem":{
            "title":"Consumed Item",
            "maxLength":4000,
            "type":"string",
            "description":"Item for which forecasts have been consumed by sales orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumedItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item for which forecasts have been consumed by sales orders.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConsumedQuantity":{
            "title":"Consumed Quantity",
            "type":"number",
            "description":"Quantity of the forecast that was consumed by the sales order or transfer order demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionDate":{
            "title":"Consumption Date",
            "type":"string",
            "description":"Date the forecast was consumed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionLevelOrAttribute":{
            "title":"Consumption Level or Attribute",
            "maxLength":4000,
            "type":"string",
            "description":"Level or attribute for which consumption finds a matching forecast record. For example, a match made by item and organization, or by using item, organization, and demand class, or by using item, project, and task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionSequence":{
            "title":"Consumption Sequence",
            "type":"integer",
            "description":"Sequence in which the forecast was consumed by the sales order or transfer order demand.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the forecast consumption detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the forecast consumption detail.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandClass":{
            "title":"Demand Class",
            "maxLength":4000,
            "type":"string",
            "description":"A classification of demand used to track and consume different types of demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandSchedule":{
            "title":"Demand Schedule",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the demand plan schedule to consume in a supply plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastCustomer":{
            "title":"Forecast Customer",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastCustomerSite":{
            "title":"Forecast Customer Site",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer site associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastDemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the forecast demand.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForecastQuantity":{
            "title":"Forecast Quantity",
            "type":"number",
            "description":"The forecast demand for the item in the planning bucket.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastRequestedItem":{
            "title":"Forecast Requested Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the requested item associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ForecastRequestedItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requested item associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the forecast consumption detail was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the forecast consumption detail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderType":{
            "title":"Order Type",
            "maxLength":4000,
            "type":"string",
            "description":"Type of order. For example, a purchase order, a sales order, or a work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderTypeCode":{
            "type":"integer",
            "description":"Code used to identify the type of order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Code used to identify an organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value used to uniquely identify an organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 10 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 11 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 12 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 13 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 14 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 15 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 3 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 4 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 5 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 6 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 7 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 8 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningAttributeNumber9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 9 associated with the forecast consumption in attribute-based planning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectGroupValue":{
            "title":"Forecast Project Group",
            "maxLength":4000,
            "type":"string",
            "description":"Project group associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectValue":{
            "title":"Forecast Project",
            "maxLength":4000,
            "type":"string",
            "description":"Project associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrTransferOrderItem":{
            "title":"Sales Order or Transfer Order Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the item associated with the sales order or transfer order demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrTransferOrderLine":{
            "title":"Sales or Transfer Order Line",
            "maxLength":150,
            "type":"string",
            "description":"Identifier for the sales order or transfer order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrTransferOrderNumber":{
            "title":"Sales or Transfer Order Number",
            "maxLength":4000,
            "type":"string",
            "description":"Order identifier on a sales order or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrTransferOrderQuantity":{
            "title":"Sales or Transfer Order Quantity",
            "type":"number",
            "description":"Quantity of the sales order or transfer order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderCustomer":{
            "title":"Sales Order Customer",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer associated with the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderCustomerId":{
            "type":"integer",
            "description":"Name of the customer associated with the sales order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderCustomerSite":{
            "title":"Sales Order Customer Site",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the customer site associated with the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber10":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 10 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber11":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 11 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber12":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 12 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber13":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 13 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber14":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 14 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber15":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 15 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber3":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 3 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber4":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 4 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber5":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 5 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber6":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 6 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber7":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 7 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber8":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 8 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderPlanningAttributeNumber9":{
            "maxLength":4000,
            "type":"string",
            "description":"Value for the planning attribute number 9 associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderProjectGroupValue":{
            "title":"Sales Order or Transfer Order Project Group",
            "maxLength":4000,
            "type":"string",
            "description":"Project group associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderProjectValue":{
            "title":"Sales Order or Transfer Order Project",
            "maxLength":4000,
            "type":"string",
            "description":"Project associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderRequestedItem":{
            "title":"Sales Order Requested Item",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the requested item associated with the sales order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderTaskValue":{
            "title":"Sales Order or Transfer Order Task",
            "maxLength":4000,
            "type":"string",
            "description":"Task associated with the sales or transfer order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderorTransferOrderOriginalShipDate":{
            "title":"Sales Order or Transfer Order Original Ship Date",
            "type":"string",
            "description":"Original ship date associated with the sales order or transfer order demand.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToConsumptionLevel":{
            "title":"Ship-to Consumption Level",
            "maxLength":4000,
            "type":"string",
            "description":"Level or attribute for which consumption finds a matching forecast record. For example, a match made by using only item and organization, or by using item, organization, and demand class, or by using item, project, and task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskValue":{
            "title":"Forecast Task",
            "maxLength":4000,
            "type":"string",
            "description":"Task associated with the forecast.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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