Jump to

• Request
• Response
• Examples

Create allocations

post

/fscmRestApi/resources/11.13.18.05/backlogManagementPlans/{BmRunId}/child/allocations

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllocationDate: string (date)
  Date of the week when the supply is allocated.
• AllocUserDef: integer
  Quantity of the allocated supply that's manually specified.
• AttributeId: integer
  Value that uniquely identifies the allocation level.
• AttributeValueId: integer
  Value that uniquely identifies the allocation node.
• BmRunId: integer
  Value that uniquely identifies the backlog management plan run.
• ESSJobId: integer
  Value that uniquely identifies the process that updates the allocation data.
• InventoryItemId: integer
  Value that uniquely identifies the item for which the allocation data is requested.
• InventoryItemName: string
  Maximum Length: 255

  Name of the item for which allocation data is requested.
• Level1AttributeName: string
  Maximum Length: 255

  Name of the top hierarchical allocation level in the allocation hierarchy.
• Level1AttributeValName: string
  Maximum Length: 255

  Name of the top hierarchical allocation level value in the allocation hierarchy.
• Level1AttributeValueId: integer
  Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.
• Level2AttributeName: string
  Maximum Length: 255

  Name of the intermediate hierarchical allocation level in the allocation hierarchy.
• Level2AttributeValName: string
  Maximum Length: 255

  Name of the intermediate hierarchical allocation level value in the allocation hierarchy.
• Level2AttributeValueId: integer
  Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.
• Level3AttributeName: string
  Maximum Length: 255

  Name of the lowest hierarchical allocation level in the allocation hierarchy.
• Level3AttributeValName: string
  Maximum Length: 255

  Name of the lowest hierarchical allocation level value in the allocation hierarchy.
• Level3AttributeValueId: integer
  Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.
• Message: string
  Message that indicates the success or failure of the bulk allocation upload.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization for which the allocation data is requested.
• OrganizationId: integer
  Value that uniquely identifies the organization for which the allocation data is requested.
• OrganizationName: string
  Maximum Length: 255

  Name of the organization for which the allocation data is requested.
• UpdateAsync: string (byte)
  Encoded allocation data when updating the allocation data using bulk update.
• UpdateMode: string
  Mode that indicates whether the allocation data is updated using the bulk update process or not.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization for which the allocation data is requested.",
            "nullable":true
        },
        "AllocUserDef":{
            "type":"integer",
            "description":"Quantity of the allocated supply that's manually specified.",
            "nullable":true
        },
        "Level3AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the lowest hierarchical allocation level in the allocation hierarchy.",
            "nullable":true
        },
        "Level2AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the intermediate hierarchical allocation level in the allocation hierarchy.",
            "nullable":true
        },
        "Level2AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.",
            "nullable":false
        },
        "Message":{
            "type":"string",
            "description":"Message that indicates the success or failure of the bulk allocation upload.",
            "nullable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the allocation level.",
            "nullable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item for which the allocation data is requested.",
            "nullable":false
        },
        "Level1AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the top hierarchical allocation level in the allocation hierarchy.",
            "nullable":true
        },
        "UpdateAsync":{
            "type":"string",
            "description":"Encoded allocation data when updating the allocation data using bulk update.",
            "format":"byte",
            "nullable":true
        },
        "UpdateMode":{
            "type":"string",
            "description":"Mode that indicates whether the allocation data is updated using the bulk update process or not.",
            "nullable":true
        },
        "Level3AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the lowest hierarchical allocation level value in the allocation hierarchy.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization for which the allocation data is requested.",
            "nullable":false
        },
        "ESSJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process that updates the allocation data.",
            "nullable":true
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":false
        },
        "Level1AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.",
            "nullable":false
        },
        "InventoryItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item for which allocation data is requested.",
            "nullable":true
        },
        "Level2AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the intermediate hierarchical allocation level value in the allocation hierarchy.",
            "nullable":true
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the allocation node.",
            "nullable":false
        },
        "Level3AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.",
            "nullable":false
        },
        "AllocationDate":{
            "type":"string",
            "description":"Date of the week when the supply is allocated.",
            "format":"date",
            "nullable":false
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization for which the allocation data is requested.",
            "nullable":true
        },
        "Level1AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the top hierarchical allocation level value in the allocation hierarchy.",
            "nullable":true
        }
    }
}

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 : backlogManagementPlans-allocations-item-response

Type: object

Show Source

• AllocationDate: string (date)
  Date of the week when the supply is allocated.
• AllocSteal: number
  Read Only: true

  Quantity of the allocation that's consumed by demands at other allocation nodes.
• AllocSup: number
  Read Only: true

  Quantity of the allocated supply.
• AllocUserDef: integer
  Quantity of the allocated supply that's manually specified.
• AttributeId: integer
  Value that uniquely identifies the allocation level.
• AttributeValueId: integer
  Value that uniquely identifies the allocation node.
• AvailSteal: number
  Read Only: true

  Quantity of allocation that's available for consumption by other allocation nodes.
• AvailSup: number
  Read Only: true

  Quantity of allocation available at the allocation node.
• BmRunId: integer
  Value that uniquely identifies the backlog management plan run.
• ConsumHistory: number
  Read Only: true

  Quantity of supply consumed at an allocation node by shipped orders.
• ConsumSup: number
  Read Only: true

  Quantity of allocation that's consumed at the allocation node.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the allocation entry.
• CumlAvailSup: number
  Read Only: true

  Quantity of cumulative allocation at the allocation node.
• ESSJobId: integer
  Value that uniquely identifies the process that updates the allocation data.
• GrossAlloc: number
  Read Only: true

  Quantity of allocation at a node and all other nodes within its hierarchy.
• GrossAllocSteal: number
  Read Only: true

  Quantity of allocation that was at a node and all other nodes within its hierarchy.
• GrossAvail: number
  Read Only: true

  Quantity of allocation available at a node and all other nodes within its hierarchy.
• GrossConsum: number
  Read Only: true

  Quantity of allocation consumed at a node and all other nodes within its hierarchy.
• GrossConsumHistory: number
  Read Only: true

  Quantity of allocation consumed by shipped orders at a node and all other nodes within its hierarchy.
• GrossCumlAvail: number
  Read Only: true

  Quantity of cumulative allocation available at a node and all other nodes within its hierarchy.
• GrossSup: number
  Read Only: true

  Quantity that's the sum of the supply in a week across all allocation nodes and the supply consumed by the shipped sales orders across all allocation nodes.
• InventoryItemId: integer
  Value that uniquely identifies the item for which the allocation data is requested.
• InventoryItemName: string
  Maximum Length: 255

  Name of the item for which allocation data is requested.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the allocation record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  Login that the user used when updating the allocation record.
• Level1AttributeName: string
  Maximum Length: 255

  Name of the top hierarchical allocation level in the allocation hierarchy.
• Level1AttributeValName: string
  Maximum Length: 255

  Name of the top hierarchical allocation level value in the allocation hierarchy.
• Level1AttributeValueId: integer
  Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.
• Level2AttributeName: string
  Maximum Length: 255

  Name of the intermediate hierarchical allocation level in the allocation hierarchy.
• Level2AttributeValName: string
  Maximum Length: 255

  Name of the intermediate hierarchical allocation level value in the allocation hierarchy.
• Level2AttributeValueId: integer
  Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.
• Level3AttributeName: string
  Maximum Length: 255

  Name of the lowest hierarchical allocation level in the allocation hierarchy.
• Level3AttributeValName: string
  Maximum Length: 255

  Name of the lowest hierarchical allocation level value in the allocation hierarchy.
• Level3AttributeValueId: integer
  Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Message that indicates the success or failure of the bulk allocation upload.
• NetWeekSup: number
  Read Only: true

  Quantity of overall supply for an item and organization in a week.
• OrganizationCode: string
  Maximum Length: 255

  Abbreviation that identifies the organization for which the allocation data is requested.
• OrganizationId: integer
  Value that uniquely identifies the organization for which the allocation data is requested.
• OrganizationName: string
  Maximum Length: 255

  Name of the organization for which the allocation data is requested.
• UpdateAsync: string (byte)
  Encoded allocation data when updating the allocation data using bulk update.
• UpdateMode: string
  Mode that indicates whether the allocation data is updated using the bulk update process or not.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the organization for which the allocation data is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the allocation entry.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Level3AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the lowest hierarchical allocation level in the allocation hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "Level2AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the intermediate hierarchical allocation level in the allocation hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "CumlAvailSup":{
            "type":"number",
            "description":"Quantity of cumulative allocation at the allocation node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GrossAvail":{
            "type":"number",
            "description":"Quantity of allocation available at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailSteal":{
            "type":"number",
            "description":"Quantity of allocation that's available for consumption by other allocation nodes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "type":"string",
            "description":"Message that indicates the success or failure of the bulk allocation upload.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the allocation level.",
            "nullable":false,
            "x-queryable":true
        },
        "Level1AttributeName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the top hierarchical allocation level in the allocation hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateAsync":{
            "type":"string",
            "description":"Encoded allocation data when updating the allocation data using bulk update.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateMode":{
            "type":"string",
            "description":"Mode that indicates whether the allocation data is updated using the bulk update process or not.",
            "nullable":true,
            "x-queryable":true
        },
        "GrossConsum":{
            "type":"number",
            "description":"Quantity of allocation consumed at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization for which the allocation data is requested.",
            "nullable":false,
            "x-queryable":true
        },
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management plan run.",
            "nullable":false,
            "x-queryable":true
        },
        "Level1AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the top hierarchical allocation level in the allocation hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item for which allocation data is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "Level2AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the intermediate hierarchical allocation level value in the allocation hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "GrossCumlAvail":{
            "type":"number",
            "description":"Quantity of cumulative allocation available at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GrossAllocSteal":{
            "type":"number",
            "description":"Quantity of allocation that was at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumHistory":{
            "type":"number",
            "description":"Quantity of supply consumed at an allocation node by shipped orders.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationDate":{
            "type":"string",
            "description":"Date of the week when the supply is allocated.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization for which the allocation data is requested.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllocSup":{
            "type":"number",
            "description":"Quantity of the allocated supply.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GrossAlloc":{
            "type":"number",
            "description":"Quantity of allocation at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the allocation record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocUserDef":{
            "type":"integer",
            "description":"Quantity of the allocated supply that's manually specified.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the allocation entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Level2AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the intermediate hierarchical allocation level in the allocation hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "GrossSup":{
            "type":"number",
            "description":"Quantity that's the sum of the supply in a week across all allocation nodes and the supply consumed by the shipped sales orders across all allocation nodes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item for which the allocation data is requested.",
            "nullable":false,
            "x-queryable":true
        },
        "Level3AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the lowest hierarchical allocation level value in the allocation hierarchy.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSJobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process that updates the allocation data.",
            "nullable":true,
            "x-queryable":true
        },
        "AvailSup":{
            "type":"number",
            "description":"Quantity of allocation available at the allocation node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocSteal":{
            "type":"number",
            "description":"Quantity of the allocation that's consumed by demands at other allocation nodes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the allocation node.",
            "nullable":false,
            "x-queryable":true
        },
        "GrossConsumHistory":{
            "type":"number",
            "description":"Quantity of allocation consumed by shipped orders at a node and all other nodes within its hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Level3AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lowest hierarchical allocation level in the allocation hierarchy.",
            "nullable":false,
            "x-queryable":true
        },
        "ConsumSup":{
            "type":"number",
            "description":"Quantity of allocation that's consumed at the allocation node.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NetWeekSup":{
            "type":"number",
            "description":"Quantity of overall supply for an item and organization in a week.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the allocation record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the allocation record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Level1AttributeValName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the top hierarchical allocation level value in the allocation hierarchy.",
            "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

Example 1 describes how to create allocation details for the backlog management plan. Example 2 describes how to upload bulk allocation data.

Example 1: Create Allocations

This example describes how to create allocation details for the backlog management plan.

Example 1 cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/backlogManagementPlans/BmRunId/child/allocations"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations"

Example 1 Request Body

The following example includes the contents of the request body in JSON format.

{
"BmRunId": -1,
"AllocationDate": "2030-01-21",
"Level1AttributeName": "BLM-All",
"Level2AttributeName": "BLM-CustParentGrp",
"Level3AttributeName": "BLM-CustGrp",
"Level1AttributeValName": "ALL",
"Level2AttributeValName": "BLM-North",
"Level3AttributeValName": "BLM-NorthWest",
"InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
"OrganizationName": "Denver Manufacturing_BLM",
"AllocUserDef": 111
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "BmRunId": -1,
    "InventoryItemId": 26470541,
    "OrganizationId": 45639,
    "AttributeId": 300100544207363,
    "AttributeValueId": 2406606,
    "Level1AttributeValueId": 2406598,
    "Level2AttributeValueId": 2406618,
    "Level3AttributeValueId": 2406606,
    "AllocationDate": "2030-01-21",
    "AllocSup": null,
    "ConsumSup": null,
    "AvailSup": null,
    "CumlAvailSup": null,
    "GrossAlloc": null,
    "GrossConsum": null,
    "GrossAvail": null,
    "GrossCumlAvail": null,
    "AllocSteal": null,
    "GrossAllocSteal": null,
    "AvailSteal": null,
    "NetWeekSup": null,
    "Level1AttributeName": "BLM-All",
    "Level2AttributeName": "BLM-CustParentGrp",
    "Level3AttributeName": "BLM-CustGrp",
    "Level1AttributeValName": "ALL",
    "Level2AttributeValName": "BLM-North",
    "Level3AttributeValName": "BLM-NorthWest",
    "InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
    "OrganizationName": "Denver Manufacturing_BLM",
    "OrganizationCode": "BLM:BLM_M1",
    "LastUpdatedBy": "BLM_ALL",
    "LastUpdateLogin": "C9C4E24FCDC34372E0534005F00A306C",
    "LastUpdateDate": "2021-08-25T12:11:41.292+00:00",
    "CreatedBy": "BLM_ALL",
    "CreationDate": "2021-08-25T12:11:41+00:00",
    "AllocUserDef": 111,
    "ESSJobId": null,
    "Message": null,
    "UpdateMode": null,
    "links": [
        {
            "rel": "self",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CE0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B941C4E40078",
            "name": "allocations",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CE0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B941C4E40078",
            "name": "allocations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1",
            "name": "backlogManagementPlans",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CE0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B941C4E40078/enclosure/UpdateAsync",
            "name": "UpdateAsync",
            "kind": "other"
        }
    ]
}

Example 2: Upload Bulk Allocation Data

This example describes how to upload bulk allocation data.

It includes the contents of the request body in JSON format that includes the UpdateAsync and UpdateMode attribute. You can use JSON format to encode [{"AllocUserDef":"{11,13,17,24,56,78,89,100,23,45,67,89,90,,,,,,,30}","OrgCode":"BLM:BLM_M1","Level2AttrValName":"BLM-North","Level3AttrValName":"BLM-NorthWest","Level1AttrValName":"ALL","ItemName":"BLM-NM-MANALLOC-PITEM01","BucketStartDate":"2030-01-07"}] for which the base64 encoded value is W3siQWxsb2NVc2VyRGVmIjoiezExLDEzLDE3LDI0LDU2LDc4LDg5LDEwMCwyMyw0NSw2Nyw4OSw5MCwsLCwsLCwzMH0iLA0KIk9yZ0NvZGUiOiJCTE06QkxNX00xIiwNCiJMZXZlbDJBdHRyVmFsTmFtZSI6IkJMTS1Ob3J0aCIsDQoiTGV2ZWwzQXR0clZhbE5hbWUiOiJCTE0tTm9ydGhXZXN0IiwNCiJMZXZlbDFBdHRyVmFsTmFtZSI6IkFMTCIsDQoiSXRlbU5hbWUiOiJCTE0tTk0tTUFOQUxMT0MtUElURU0wMSIsDQoiQnVja2V0U3RhcnREYXRlIjoiMjAzMC0wMS0wNyJ9XQ==. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

Example 2 Request Body

The following example includes the contents of the request body in JSON format:

{
"ESSJobId" : null,
"UpdateAsync": "W3siQWxsb2NVc2VyRGVmIjoiezExLDEzLDE3LDI0LDU2LDc4LDg5LDEwMCwyMyw0NSw2Nyw4OSw5MCwsLCwsLCwzMH0iLA0KIk9yZ0NvZGUiOiJCTE06QkxNX00xIiwNCiJMZXZlbDJBdHRyVmFsTmFtZSI6IkJMTS1Ob3J0aCIsDQoiTGV2ZWwzQXR0clZhbE5hbWUiOiJCTE0tTm9ydGhXZXN0IiwNCiJMZXZlbDFBdHRyVmFsTmFtZSI6IkFMTCIsDQoiSXRlbU5hbWUiOiJCTE0tTk0tTUFOQUxMT0MtUElURU0wMSIsDQoiQnVja2V0U3RhcnREYXRlIjoiMjAzMC0wMS0wNyJ9XQ==",
"Message": null,
"UpdateMode": "batch"  
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
    "BmRunId": -1,
    "InventoryItemId": -23453,
    "OrganizationId": -23453,
    "AttributeId": -23453,
    "AttributeValueId": -23453,
    "Level1AttributeValueId": -23453,
    "Level2AttributeValueId": -23453,
    "Level3AttributeValueId": -23453,
    "AllocationDate": "2030-02-11",
    "AllocSup": null,
    "ConsumSup": null,
    "AvailSup": null,
    "CumlAvailSup": null,
    "GrossAlloc": null,
    "GrossConsum": null,
    "GrossAvail": null,
    "GrossCumlAvail": null,
    "AllocSteal": null,
    "GrossAllocSteal": null,
    "AvailSteal": null,
    "NetWeekSup": null,
    "Level1AttributeName": null,
    "Level2AttributeName": null,
    "Level3AttributeName": null,
    "Level1AttributeValName": null,
    "Level2AttributeValName": null,
    "Level3AttributeValName": null,
    "InventoryItemName": null,
    "OrganizationName": null,
    "OrganizationCode": null,
    "LastUpdatedBy": "BLM_ALL",
    "LastUpdateLogin": "CB187496A57C4669E053A80AF20AFB1E",
    "LastUpdateDate": "2021-09-10T08:51:22.198+00:00",
    "CreatedBy": "BLM_ALL",
    "CreationDate": "2021-09-10T08:51:22+00:00",
    "AllocUserDef": null,
    "ESSJobId": 309893,
    "Message": "A scheduled process with process ID 309893 has been submitted. Refer to the scheduled processes log file for the detailed response. (MSC-2806192)",
    "UpdateMode": "batch",
    "links": [
        {
            "rel": "self",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B9ADEA700078",
            "name": "allocations",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B9ADEA700078",
            "name": "allocations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1",
            "name": "backlogManagementPlans",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708FFFFFFFFFFFFA4630000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B9ADEA700078/enclosure/UpdateAsync",
            "name": "UpdateAsync",
            "kind": "other"
        }
    ]
}

Back to Top