Get all bill of resources

get

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/BillOfResources

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • 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>
  • 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).
  • 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
  • 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

    • BorSimRowFinder Find the bill of resources according to the unique identifier of the bill of resources
      Finder Variables
      • BorId; integer; Value that uniquely identifies the bill of resources.
    • PrimaryKey Find bill of resources according to the primary key criteria.
      Finder Variables
      • BorId; integer; Value that uniquely identifies the bill of resources record.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AssemblyDescription; string; Description of the assembly item.
    • AssemblyItemId; integer; Value that uniquely identifies the assembly item.
    • AssemblyItemLevel; string; Data load level of the item being produced. Valid values are Item and Category.
    • AssemblyItemName; string; Name of the assembly item.
    • AssemblyQuantity; number; Quantity of the item being produced.
    • AssemblyUOM; string; Planning unit of measure of the assembly item.
    • BasisType; integer; Value that indicates whether the component item or resource usage quantity in an assembly item's bill of resources is fixed or variable. Contains one of the following values: 1 or 2. If 1, then usage quantity is variable. If 2, then usage quantity is fixed. The default value is 1.
    • BorId; integer; Value that uniquely identifies the bill of resources.
    • CatalogId; integer; Value that uniquely identifies the catalog.
    • CatalogName; string; Category set or name of the catalog to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
    • CategoryId; integer; Value that uniquely identifies the category.
    • CategoryName; string; Name of the category to which an item belongs. If Assembly Item Level is set to Category, then this value is required.
    • CategoryUOM; string; Planning unit of measure of the category.
    • ComponentDescription; string; Description of the component item.
    • ComponentItemId; integer; Value that uniquely identifies the component item.
    • ComponentItemName; string; Name of the component item.
    • ComponentUOM; string; Planning unit of measure of the component item.
    • ComponentUsageQuantity; number; Quantity of the item being consumed.
    • ConsumptionType; string; Type of consumption. This attribute indicates whether an item or resource is being consumed. Valid values are Item and Resource.
    • CreatedBy; string; User who created the bill of resources.
    • CreationDate; string; Date and time when the user created the bill of resources.
    • EffectiveEndDate; string; Date when the component item or resource is no longer available.
    • EffectiveStartDate; string; Date when the component item or resource is available.
    • FindNumber; integer; Number that uniquely identifies a component when the same component occurs multiple times at the same level in a bill of material.
    • LastUpdateDate; string; User who most recently updated the bill of resources.
    • LastUpdatedBy; string; Date and time when the user most recently updated the bill of resources.
    • LeadTimeOffsetInDays; number; Value that indicates the number of days for which the planning engine offsets the consumption of a component or resource.
    • OptionDependent; integer; Value that indicates whether the resource in an assembly item's bill of resources is used in operations that are dependent on the choice of one or multiple optional components. Contains one of the following values: 1 or 2. If 1, then the resource is option dependent. If 2, then the resource isn't option dependent. This attribute doesn't have a default value.
    • Organization; string; Abbreviation that identifies the organization associated with the item.
    • OrganizationId; integer; Value that uniquely identifies the organization.
    • ResourceCode; string; Abbreviation that identifies the resource.
    • ResourceId; integer; Value that uniquely identifies the resource.
    • ResourceUOM; string; Unit of measure associated with the resource.
    • ResourceUsageQuantity; number; Quantity of the resource being consumed.
    • SourceOrganization; string; Name of the organization where the component or resource is defined.
    • SourceOrganizationId; integer; Value that uniquely identifies the source organization.
    • WorkCenterCode; string; Abbreviation that identifies the work center.
    • WorkCenterId; integer; Value that uniquely identifies the work center.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : simulationSets-BillOfResources
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : simulationSets-BillOfResources-item-response
Type: object
Show Source
Nested Schema : Alternate Resources
Type: array
Title: Alternate Resources
The Alternate Resources resource manages the collected alternate resources in the bill of resources that are used as input for the planning engine.
Show Source
Nested Schema : Option Dependent Resource Details
Type: array
Title: Option Dependent Resource Details
In the bill of resources, the Option Dependent Resource Details resource manages the details for resources used in operations that are dependent on the choice of one or multiple optional components. The details are used as input for the planning engine.
Show Source
Nested Schema : Substitute Components
Type: array
Title: Substitute Components
The Substitute Components resource manages the collected substitute component, in the bill of resources, which is used as input for the planning engine.
Show Source
Nested Schema : simulationSets-BillOfResources-AlternateResources-item-response
Type: object
Show Source
Nested Schema : simulationSets-BillOfResources-OptionDependentDetails-item-response
Type: object
Show Source
Nested Schema : simulationSets-BillOfResources-SubstituteComponents-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all bill of resources.

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/simulationSets/SimulationSetId/child/BillOfResources"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "BorId": 91078,
            "OrganizationId": 10025,
            "Organization": "ASWAB",
            "AssemblyItemId": 19455,
            "AssemblyItemName": "LH-eBook3G-PCBSubAssy",
            "AssemblyDescription": "LH-eBook3G-PCBSubAssy",
            "AssemblyQuantity": 1,
            "AssemblyUOM": "EA",
            "AssemblyItemLevel": "Item",
            "CatalogId": -23453,
            "CatalogName": null,
            "CategoryId": -23453,
            "CategoryName": null,
            "CategoryUOM": null,
            "ConsumptionType": "Resource",
            "ComponentItemId": -23453,
            "ComponentItemName": null,
            "ComponentDescription": null,
            "ComponentUsageQuantity": 0,
            "ComponentUOM": null,
            "WorkCenterId": 25122,
            "WorkCenterCode": "LH-eBook3G-PCBWC1",
            "ResourceId": 25121,
            "ResourceCode": "LH-eBook3G-PCBASSY1",
            "ResourceUsageQuantity": 1,
            "ResourceUOM": "HRS",
            "EffectiveStartDate": null,
            "EffectiveEndDate": null,
            "CreatedBy": "APS_ALL",
            "CreationDate": "2021-10-20T13:16:30.508+00:00",
            "LastUpdateDate": "2021-10-20T13:16:30.045+00:00",
            "LastUpdatedBy": "APS_ALL",
            "SourceOrganizationId": 10025,
            "SourceOrganization": "ASWAB",
            "LeadTimeOffsetInDays": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078",
                    "name": "BillOfResources",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078",
                    "name": "BillOfResources",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009",
                    "name": "simulationSets",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078/child/AlternateResources",
                    "name": "AlternateResources",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91078/child/SubstituteComponents",
                    "name": "SubstituteComponents",
                    "kind": "collection"
                }
            ]
        },
        {
            "BorId": 103000,
            "OrganizationId": 10025,
            "Organization": "ASWAB",
            "AssemblyItemId": 19455,
            "AssemblyItemName": "LH-eBook3G-PCBSubAssy",
            "AssemblyDescription": "LH-eBook3G-PCBSubAssy",
            "AssemblyQuantity": 1,
            "AssemblyUOM": "EA",
            "AssemblyItemLevel": "Item",
            "CatalogId": -23453,
            "CatalogName": null,
            "CategoryId": -23453,
            "CategoryName": null,
            "CategoryUOM": null,
            "ConsumptionType": "Item",
            "ComponentItemId": 19489,
            "ComponentItemName": "LH-eBook4G-PCBSubAssy-Memory 4GB-335",
            "ComponentDescription": "LH-eBook4G-PCBSubAssy-Memory 4GB-335",
            "ComponentUsageQuantity": 1,
            "ComponentUOM": "EA",
            "WorkCenterId": null,
            "WorkCenterCode": null,
            "ResourceId": -23453,
            "ResourceCode": null,
            "ResourceUsageQuantity": 0,
            "ResourceUOM": null,
            "EffectiveStartDate": null,
            "EffectiveEndDate": null,
            "CreatedBy": "APS_ALL",
            "CreationDate": "2021-10-21T13:45:53.593+00:00",
            "LastUpdateDate": "2021-10-21T13:45:53.210+00:00",
            "LastUpdatedBy": "APS_ALL",
            "SourceOrganizationId": 10025,
            "SourceOrganization": "ASWAB",
            "LeadTimeOffsetInDays": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/103000",
                    "name": "BillOfResources",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/103000",
                    "name": "BillOfResources",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009",
                    "name": "simulationSets",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/103000/child/AlternateResources",
                    "name": "AlternateResources",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/103000/child/SubstituteComponents",
                    "name": "SubstituteComponents",
                    "kind": "collection"
                }
            ]
        },
        {
            "BorId": 91079,
            "OrganizationId": 10025,
            "Organization": "ASWAB",
            "AssemblyItemId": 19455,
            "AssemblyItemName": "LH-eBook3G-PCBSubAssy",
            "AssemblyDescription": "LH-eBook3G-PCBSubAssy",
            "AssemblyQuantity": 1,
            "AssemblyUOM": "EA",
            "AssemblyItemLevel": "Item",
            "CatalogId": -23453,
            "CatalogName": null,
            "CategoryId": -23453,
            "CategoryName": null,
            "CategoryUOM": null,
            "ConsumptionType": "Item",
            "ComponentItemId": 19488,
            "ComponentItemName": "LH-eBook3G-PCBSubAssy-Memory 2GB-332",
            "ComponentDescription": "LH-eBook3G-PCBSubAssy-Memory 2GB-332",
            "ComponentUsageQuantity": 1.5,
            "ComponentUOM": "EA",
            "WorkCenterId": null,
            "WorkCenterCode": null,
            "ResourceId": -23453,
            "ResourceCode": null,
            "ResourceUsageQuantity": 0,
            "ResourceUOM": null,
            "EffectiveStartDate": null,
            "EffectiveEndDate": null,
            "CreatedBy": "APS_ALL",
            "CreationDate": "2021-10-20T13:16:30.623+00:00",
            "LastUpdateDate": "2021-10-20T13:16:30.051+00:00",
            "LastUpdatedBy": "APS_ALL",
            "SourceOrganizationId": 10025,
            "SourceOrganization": "ASWAB",
            "LeadTimeOffsetInDays": 0,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079",
                    "name": "BillOfResources",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079",
                    "name": "BillOfResources",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009",
                    "name": "simulationSets",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/AlternateResources",
                    "name": "AlternateResources",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources/91079/child/SubstituteComponents",
                    "name": "SubstituteComponents",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/simulationSets/300100081236009/child/BillOfResources",
            "name": "BillOfResources",
            "kind": "collection"
        }
    ]
}
Back to Top