Jump to

• Request
• Response

Allocate Measure Reports

post

/fscmRestApi/backlogManagement/latest/backlogPlans/allocationMeasuresReports

Allocate Measure Reports

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllocationScenarioId: number
  Unique identifier of an allocation scenario.
• BmrunId: number
  Value that uniquely identifies the backlog management simulation plan run.
• ItemId: number
  Unique identifier of the items specified in an allocation scenario.
• OrgId: number
  Value that uniquely identifies the organization for which the allocation data are requested.

{
    "type":"object",
    "properties":{
        "BmrunId":{
            "type":"number",
            "description":"Value that uniquely identifies the backlog management simulation plan run."
        },
        "AllocationScenarioId":{
            "type":"number",
            "description":"Unique identifier of an allocation scenario."
        },
        "ItemId":{
            "type":"number",
            "description":"Unique identifier of the items specified in an allocation scenario."
        },
        "OrgId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization for which the allocation data are requested."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Result of processing the request, which includes fetching of allocation mesures for the given allocation node, item, organization and bucket date.

Body ()

Root Schema : BLMSupplyAllocationOutput

Type: object

Show Source

• AllocScenarioId: number
  Unique identifier of an allocation scenario.
• BLMSupplyAllocResultList: array BLMSupplyAllocResultList
• BmRunId: number
  Unique identifier of an allocation scenario used in a simulation run.
• Count: number
  Count is total number of Supply Allocation Results fetched from the post operation of allocationMeasuresReports.
• HasMore: number
  It indicates if there is any output result left to be fetched beyond the limit.
• Limit: number
  It indicates maximum number of result that can be fetched at a time . This can be set by user as query parameter.
• Offset: number
  It indicates lower index of result fetched . It can be set by user as query parameter.

{
    "type":"object",
    "properties":{
        "BmRunId":{
            "type":"number",
            "description":"Unique identifier of an allocation scenario used in a simulation run."
        },
        "AllocScenarioId":{
            "type":"number",
            "description":"Unique identifier of an allocation scenario."
        },
        "BLMSupplyAllocResultList":{
            "type":"array",
            "description":"",
            "items":{
                "$ref":"#/components/schemas/BLMSupplyAllocResult"
            }
        },
        "Count":{
            "type":"number",
            "description":" Count is total number of Supply Allocation Results fetched from the post operation of allocationMeasuresReports. "
        },
        "HasMore":{
            "type":"number",
            "description":" It indicates if there is any output result left to be fetched beyond the limit. "
        },
        "Limit":{
            "type":"number",
            "description":" It indicates maximum number of result that can be fetched at a time . This can be set by user as query parameter."
        },
        "Offset":{
            "type":"number",
            "description":" It indicates lower index of result fetched . It can be set by user as query parameter. "
        }
    }
}

Nested Schema : BLMSupplyAllocResultList

Type: array

Show Source

• Array of: object BLMSupplyAllocResult

{
    "type":"array",
    "description":"",
    "items":{
        "$ref":"#/components/schemas/BLMSupplyAllocResult"
    }
}

Nested Schema : BLMSupplyAllocResult

Type: object

Show Source

• AllocationNode: string ()
  An item's supply at an organization can be allocated to different customer groups, demand channels, and regions, known as allocation nodes. Allocation nodes help preserve the supply of scarce items across different demand channels and ensure equitable fulfillment across them.
• BLMWeeklyAllocationList: array BLMWeeklyAllocationList
  Header-level response attributes that indicates the quantity of supply allocated to a particular allocation node for the given week.
• ItemId: number
  Unique identifier of the items specified in an allocation scenario.
• ItemName: string
  Names of the items specified in an allocation scenario.
• OrgCode: string
  Code of the organization specified in an allocation scenario.
• OrgId: number
  Unique identifier of the organization specified in an allocation scenario.

{
    "type":"object",
    "properties":{
        "ItemId":{
            "type":"number",
            "description":"Unique identifier of the items specified in an allocation scenario."
        },
        "OrgId":{
            "type":"number",
            "description":"Unique identifier of the organization specified in an allocation scenario."
        },
        "ItemName":{
            "type":"string",
            "description":"Names of the items specified in an allocation scenario."
        },
        "OrgCode":{
            "type":"string",
            "description":"Code of the organization specified in an allocation scenario."
        },
        "AllocationNode":{
            "type":"string",
            "description":"An item's supply at an organization can be allocated to different customer groups, demand channels, and regions, known as allocation nodes. Allocation nodes help preserve the supply of scarce items across different demand channels and ensure equitable fulfillment across them.",
            "format":""
        },
        "BLMWeeklyAllocationList":{
            "type":"array",
            "description":"Header-level response attributes that indicates the quantity of supply allocated to a particular allocation node for the given week.",
            "items":{
                "$ref":"#/components/schemas/BLMWeeklyAllocation"
            }
        }
    }
}

Nested Schema : BLMWeeklyAllocationList

Type: array

Header-level response attributes that indicates the quantity of supply allocated to a particular allocation node for the given week.

Show Source

• Array of: object BLMWeeklyAllocation

{
    "type":"array",
    "description":"Header-level response attributes that indicates the quantity of supply allocated to a particular allocation node for the given week.",
    "items":{
        "$ref":"#/components/schemas/BLMWeeklyAllocation"
    }
}

Nested Schema : BLMWeeklyAllocation

Type: object

Show Source

• AllocatedStealing: number (double)
  Supply allocated to a node through stealing.
• AllocatedSupply: number (double)
  Supply allocated to an allocation node.
• AllocatedToChild: number (double)
  Supply allocated to child nodes.
• AllocConsumeHistory: number (double)
  Supply consumed at an allocation node by shipped orders.
• AvailablePercentage: number (double)
  Its value is calculated as (availableSupply/allocatedSupply)*100
• AvailableStealing: number (double)
  Proportion of the allocated supply that's available for stealing.
• AvailableSupply: number (double)
  Supply available at an allocation node.
• BLMWeeklyAllocationBucketStartDate: string (date-time)
  Date from which the material supply allocation is effective.
• ConsumedSupply: number (double)
  Supply consumed at an allocation node.
• CumulativeAvailSupply: number (double)
  Cumulative supply at an allocation node.
• DemandQuantity: number (double)
  Total number of demand units at an allocation node with requested dates in the current week.
• DemandQuantityOnTime: number (double)
  Number of units of demand that are fulfilled on time.
• GrossAllocatedStealing: number (double)
  Supply allocated to a node and its child nodes through stealing.
• GrossAllocation: number (double)
  Allocated supply at a specific node and its child nodes.
• GrossAvailability: number (double)
  Supply available at a specific node and its child nodes.
• GrossConsumeHistory: number (double)
  Gross consumed supply by shipped orders
• GrossConsumption: number (double)
  Supply consumed at a specific node and its child nodes.
• GrossCumulativeAvailability: number (double)
  Cumulative supply at an allocation node and its child nodes.
• GrossSupply: number (double)
  Sum of total supply in a week across all allocation nodes and supply consumed by the shipped sales orders across all allocation nodes.
• NextWeekSupply: number (double)
  Total supply in a week across all allocation nodes
• PlanFillPercent: number (double)
  Percentage of the demand planned by the requested date.
• PlanOnTimePercent: number (double)
  Percentage of demand planned on time.
• Revenue: number (double)
  Revenue from demands in the current week.
• RevenuePlanOnTime: number (double)
  Revenue from demands planned on time.
• RevenueSchOnTime: number (double)
  Revenue from demands scheduled on time.
• ScheduleFillPercent: number (double)
  Percentage of the total demand scheduled by the requested date.
• ScheduleOnTimePercent: number (double)
  Percentage of demand scheduled on time.
• UserDefinedAllocation: number (double)
  Manually specified supply allocation at an allocation node.

{
    "type":"object",
    "properties":{
        "BLMWeeklyAllocationBucketStartDate":{
            "format":"date-time",
            "type":"string",
            "description":"Date from which the material supply allocation is effective."
        },
        "AllocatedSupply":{
            "format":"double",
            "type":"number",
            "description":"Supply allocated to an allocation node."
        },
        "ConsumedSupply":{
            "format":"double",
            "type":"number",
            "description":"Supply consumed at an allocation node."
        },
        "AvailableSupply":{
            "format":"double",
            "type":"number",
            "description":"Supply available at an allocation node."
        },
        "CumulativeAvailSupply":{
            "format":"double",
            "type":"number",
            "description":"Cumulative supply at an allocation node."
        },
        "GrossAllocation":{
            "format":"double",
            "type":"number",
            "description":"Allocated supply at a specific node and its child nodes."
        },
        "GrossConsumption":{
            "format":"double",
            "type":"number",
            "description":"Supply consumed at a specific node and its child nodes."
        },
        "GrossAvailability":{
            "format":"double",
            "type":"number",
            "description":"Supply available at a specific node and its child nodes."
        },
        "GrossSupply":{
            "format":"double",
            "type":"number",
            "description":"Sum of total supply in a week across all allocation nodes and supply consumed by the shipped sales orders across all allocation nodes."
        },
        "AllocatedStealing":{
            "format":"double",
            "type":"number",
            "description":"Supply allocated to a node through stealing."
        },
        "GrossAllocatedStealing":{
            "format":"double",
            "type":"number",
            "description":"Supply allocated to a node and its child nodes through stealing."
        },
        "AvailableStealing":{
            "format":"double",
            "type":"number",
            "description":"Proportion of the allocated supply that's available for stealing."
        },
        "NextWeekSupply":{
            "format":"double",
            "type":"number",
            "description":"Total supply in a week across all allocation nodes"
        },
        "UserDefinedAllocation":{
            "format":"double",
            "type":"number",
            "description":"Manually specified supply allocation at an allocation node."
        },
        "GrossCumulativeAvailability":{
            "format":"double",
            "type":"number",
            "description":"Cumulative supply at an allocation node and its child nodes."
        },
        "AllocConsumeHistory":{
            "format":"double",
            "type":"number",
            "description":"Supply consumed at an allocation node by shipped orders."
        },
        "GrossConsumeHistory":{
            "format":"double",
            "type":"number",
            "description":"Gross consumed supply by shipped orders"
        },
        "AllocatedToChild":{
            "format":"double",
            "type":"number",
            "description":"Supply allocated to child nodes."
        },
        "DemandQuantity":{
            "format":"double",
            "type":"number",
            "description":"Total number of demand units at an allocation node with requested dates in the current week."
        },
        "DemandQuantityOnTime":{
            "format":"double",
            "type":"number",
            "description":"Number of units of demand that are fulfilled on time."
        },
        "PlanFillPercent":{
            "format":"double",
            "type":"number",
            "description":"Percentage of the demand planned by the requested date."
        },
        "ScheduleFillPercent":{
            "format":"double",
            "type":"number",
            "description":"Percentage of the total demand scheduled by the requested date."
        },
        "ScheduleOnTimePercent":{
            "format":"double",
            "type":"number",
            "description":"Percentage of demand scheduled on time."
        },
        "Revenue":{
            "format":"double",
            "type":"number",
            "description":"Revenue from demands in the current week."
        },
        "RevenuePlanOnTime":{
            "format":"double",
            "type":"number",
            "description":"Revenue from demands planned on time."
        },
        "RevenueSchOnTime":{
            "format":"double",
            "type":"number",
            "description":"Revenue from demands scheduled on time."
        },
        "PlanOnTimePercent":{
            "format":"double",
            "type":"number",
            "description":"Percentage of demand planned on time."
        },
        "AvailablePercentage":{
            "format":"double",
            "type":"number",
            "description":" Its value is calculated as (availableSupply/allocatedSupply)*100 "
        }
    }
}

Back to Top