Jump to

• Request
• Response
• Examples

Get all allocations

get

/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.

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: Finds allocations according to the primary key criteria.
    Finder Variables:
    • AllocationDate; string; Date when the allocation week begins for which allocation data is requested.
    • AttributeId; integer; Value that uniquely identifies the level of the allocation node for which allocation data is requested.
    • AttributeValueId; integer; Value that uniquely identifies the level of the allocation node for which allocation data is requested.
    • BmRunId; integer; Value that uniquely identifies the backlog management plan run.
    • InventoryItemId; integer; Value that uniquely identifies the item for which allocation data is requested.
    • OrganizationId; integer; Value that uniquely identifies the organization for which allocation data is requested.
• 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:
  

  • AllocSteal; number; Quantity of the allocation that's consumed by demands at other allocation nodes.
  • AllocSup; number; Quantity of the allocated supply.
  • AllocUserDef; integer; Quantity of the allocated supply that's manually specified.
  • AllocationDate; string; Date of the week when the supply is allocated.
  • AttributeId; integer; Value that uniquely identifies the allocation level.
  • AttributeValueId; integer; Value that uniquely identifies the allocation node.
  • AvailSteal; number; Quantity of allocation that's available for consumption by other allocation nodes.
  • AvailSup; number; Quantity of allocation available at the allocation node.
  • BmRunId; integer; Value that uniquely identifies the backlog management plan run.
  • ConsumHistory; number; Quantity of supply consumed at an allocation node by shipped orders.
  • ConsumSup; number; Quantity of allocation that's consumed at the allocation node.
  • CreatedBy; string; User who created the allocation entry.
  • CreationDate; string; Date and time when the user created the allocation entry.
  • CumlAvailSup; number; Quantity of cumulative allocation at the allocation node.
  • ESSJobId; integer; Value that uniquely identifies the process that updates the allocation data.
  • GrossAlloc; number; Quantity of allocation at a node and all other nodes within its hierarchy.
  • GrossAllocSteal; number; Quantity of allocation that was at a node and all other nodes within its hierarchy.
  • GrossAvail; number; Quantity of allocation available at a node and all other nodes within its hierarchy.
  • GrossConsum; number; Quantity of allocation consumed at a node and all other nodes within its hierarchy.
  • GrossConsumHistory; number; Quantity of allocation consumed by shipped orders at a node and all other nodes within its hierarchy.
  • GrossCumlAvail; number; Quantity of cumulative allocation available at a node and all other nodes within its hierarchy.
  • GrossSup; number; 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; Name of the item for which allocation data is requested.
  • LastUpdateDate; string; Date and time when the user most recently updated the allocation record.
  • LastUpdateLogin; string; Login that the user used when updating the allocation record.
  • LastUpdatedBy; string; User who most recently updated the allocation record.
  • Level1AttributeName; string; Name of the top hierarchical allocation level in the allocation hierarchy.
  • Level1AttributeValName; string; 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; Name of the intermediate hierarchical allocation level in the allocation hierarchy.
  • Level2AttributeValName; string; 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; Name of the lowest hierarchical allocation level in the allocation hierarchy.
  • Level3AttributeValName; string; 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.
  • NetWeekSup; number; Quantity of overall supply for an item and organization in a week.
  • OrganizationCode; string; 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; Name of the organization for which the allocation data is requested.
  • UpdateAsync; string; 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.
• 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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : backlogManagementPlans-allocations

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":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "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"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/backlogManagementPlans-allocations-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object backlogManagementPlans-allocations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/backlogManagementPlans-allocations-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 : 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

This example describes how to get all allocation details from the backlog management plan.

Example cURL Command

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

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

For example:

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

Example Response Body

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

{
    "items": [
        {
            "BmRunId": -1,
            "InventoryItemId": 26470541,
            "OrganizationId": 45639,
            "AttributeId": 300100544207360,
            "AttributeValueId": 2406598,
            "Level1AttributeValueId": 2406598,
            "Level2AttributeValueId": -23453,
            "Level3AttributeValueId": -23453,
            "AllocationDate": "2030-01-07",
            "AllocSup": 15,
            "ConsumSup": 15,
            "AvailSup": 0,
            "CumlAvailSup": 0,
            "GrossAlloc": 100,
            "GrossConsum": 85,
            "GrossAvail": 15,
            "GrossCumlAvail": 15,
            "AllocSteal": 0,
            "GrossAllocSteal": 0,
            "AvailSteal": null,
            "NetWeekSup": 100,
            "Level1AttributeName": "BLM-All",
            "Level2AttributeName": null,
            "Level3AttributeName": null,
            "Level1AttributeValName": "ALL",
            "Level2AttributeValName": null,
            "Level3AttributeValName": null,
            "InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
            "OrganizationName": "Denver Manufacturing_BLM",
            "OrganizationCode": "BLM:BLM_M1",
            "LastUpdatedBy": "BLM_ALL",
            "LastUpdateLogin": "C9D4A8E568E5171CE0534005F00AE97C",
            "LastUpdateDate": "2021-08-18T12:30:18.886+00:00",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2021-08-18T12:30:18.886+00:00",
            "AllocUserDef": null,
            "ESSJobId": null,
            "Message": null,
            "UpdateMode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A000000000EACED00057708000000000024B8C60000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078",
                    "name": "allocations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A000000000EACED00057708000000000024B8C60000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078",
                    "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/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A000000000EACED00057708000000000024B8C60000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078/enclosure/UpdateAsync",
                    "name": "UpdateAsync",
                    "kind": "other"
                }
            ]
        },    
        {
            "BmRunId": -1,
            "InventoryItemId": 26470541,
            "OrganizationId": 45639,
            "AttributeId": 300100544207363,
            "AttributeValueId": 2406605,
            "Level1AttributeValueId": 2406598,
            "Level2AttributeValueId": 2406618,
            "Level3AttributeValueId": 2406605,
            "AllocationDate": "2030-01-14",
            "AllocSup": 35,
            "ConsumSup": 35,
            "AvailSup": 0,
            "CumlAvailSup": 0,
            "GrossAlloc": 35,
            "GrossConsum": 35,
            "GrossAvail": 0,
            "GrossCumlAvail": 0,
            "AllocSteal": 0,
            "GrossAllocSteal": 0,
            "AvailSteal": null,
            "NetWeekSup": 140,
            "Level1AttributeName": "BLM-All",
            "Level2AttributeName": "BLM-CustParentGrp",
            "Level3AttributeName": "BLM-CustGrp",
            "Level1AttributeValName": "ALL",
            "Level2AttributeValName": "BLM-North",
            "Level3AttributeValName": "BLM-NorthEast",
            "InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
            "OrganizationName": "Denver Manufacturing_BLM",
            "OrganizationCode": "BLM:BLM_M1",
            "LastUpdatedBy": "BLM_ALL",
            "LastUpdateLogin": "C9D4A8E568E5171CE0534005F00AE97C",
            "LastUpdateDate": "2021-08-18T12:30:18.886+00:00",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2021-08-18T12:30:18.886+00:00",
            "AllocUserDef": null,
            "ESSJobId": null,
            "Message": null,
            "UpdateMode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CD0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078",
                    "name": "allocations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CD0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078",
                    "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/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8CD0000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078/enclosure/UpdateAsync",
                    "name": "UpdateAsync",
                    "kind": "other"
                }
            ]
        },                        
        {
            "BmRunId": -1,
            "InventoryItemId": 26470541,
            "OrganizationId": 45639,
            "AttributeId": 300100544207363,
            "AttributeValueId": 2406616,
            "Level1AttributeValueId": 2406598,
            "Level2AttributeValueId": 2406622,
            "Level3AttributeValueId": 2406616,
            "AllocationDate": "2030-01-07",
            "AllocSup": 10,
            "ConsumSup": 10,
            "AvailSup": 0,
            "CumlAvailSup": 0,
            "GrossAlloc": 10,
            "GrossConsum": 10,
            "GrossAvail": 0,
            "GrossCumlAvail": 0,
            "AllocSteal": 0,
            "GrossAllocSteal": 0,
            "AvailSteal": null,
            "NetWeekSup": 100,
            "Level1AttributeName": "BLM-All",
            "Level2AttributeName": "BLM-CustParentGrp",
            "Level3AttributeName": "BLM-CustGrp",
            "Level1AttributeValName": "ALL",
            "Level2AttributeValName": "BLM-South",
            "Level3AttributeValName": "BLM-SouthWest",
            "InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
            "OrganizationName": "Denver Manufacturing_BLM",
            "OrganizationCode": "BLM:BLM_M1",
            "LastUpdatedBy": "BLM_ALL",
            "LastUpdateLogin": "C9D4A8E568E5171CE0534005F00AE97C",
            "LastUpdateDate": "2021-08-18T12:30:18.886+00:00",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2021-08-18T12:30:18.886+00:00",
            "AllocUserDef": null,
            "ESSJobId": null,
            "Message": null,
            "UpdateMode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078",
                    "name": "allocations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078",
                    "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/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B8F9ABDC0078/enclosure/UpdateAsync",
                    "name": "UpdateAsync",
                    "kind": "other"
                }
            ]
        },
        . . . 
        . . .         {
            "BmRunId": -1,
            "InventoryItemId": 26470541,
            "OrganizationId": 45639,
            "AttributeId": 300100544207363,
            "AttributeValueId": 2406616,
            "Level1AttributeValueId": 2406598,
            "Level2AttributeValueId": 2406622,
            "Level3AttributeValueId": 2406616,
            "AllocationDate": "2030-01-14",
            "AllocSup": 17.5,
            "ConsumSup": 15,
            "AvailSup": 2.5,
            "CumlAvailSup": 2.5,
            "GrossAlloc": 17.5,
            "GrossConsum": 15,
            "GrossAvail": 2.5,
            "GrossCumlAvail": 2.5,
            "AllocSteal": 0,
            "GrossAllocSteal": 0,
            "AvailSteal": null,
            "NetWeekSup": 140,
            "Level1AttributeName": "BLM-All",
            "Level2AttributeName": "BLM-CustParentGrp",
            "Level3AttributeName": "BLM-CustGrp",
            "Level1AttributeValName": "ALL",
            "Level2AttributeValName": "BLM-South",
            "Level3AttributeValName": "BLM-SouthWest",
            "InventoryItemName": "BLM-ALLOC-JI'WithDiffAllocation",
            "OrganizationName": "Denver Manufacturing_BLM",
            "OrganizationCode": "BLM:BLM_M1",
            "LastUpdatedBy": "BLM_ALL",
            "LastUpdateLogin": "C9D4A8E568E5171CE0534005F00AE97C",
            "LastUpdateDate": "2021-08-18T12:30:18.886+00:00",
            "CreatedBy": "BLM_ALL",
            "CreationDate": "2021-08-18T12:30:18.886+00:00",
            "AllocUserDef": null,
            "ESSJobId": null,
            "Message": null,
            "UpdateMode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078",
                    "name": "allocations",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078",
                    "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/00070000000EACED00057708FFFFFFFFFFFFFFFF0000000EACED00057708000000000193E88D0000000EACED00057708000000000000B2470000000EACED00057708FFFFFFFFFFFFA4630000000EACED00057708000110F09A559A030000000EACED00057708000000000024B8D80000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001B91DB8600078/enclosure/UpdateAsync",
                    "name": "UpdateAsync",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 16,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "servername/fscmRestApi/resources/version/backlogManagementPlans/-1/child/allocations",
            "name": "allocations",
            "kind": "collection"
        }
    ]
}   

Back to Top