Get all components

get

/fscmRestApi/resources/11.13.18.05/configuredItems/{LineExplId}/child/components/{LineExplId2}/child/components

Request

Path Parameters
  • Value that uniquely identifies the generated configured item.
  • 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:

    • PrimaryKey: Find components according to the unique identifier in the explosion table.
      Finder Variables:
      • LineExplId; integer; Value that uniquely identifies the generated configured item.
  • 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:
    • BasisType; integer; Value that identifies the component usage as fixed or variable. Value is 1. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
    • BasisTypeDescription; string; Value that identifies the component usage as fixed or variable. Value for items is variable component usage. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
    • BillSequenceId; integer; Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
    • CheckATP; number; Identifies whether availability to promise (ATP) should be checked for component. Valid values include 1: Material only, 2: Material and Resource, 3: None, or 4: Resource only. The value is retrieved from the model structure. A list of accepted values is defined in the lookup type EGP_ORDATPCHECKVS_TYPE.
    • ComponentHierarchy; string; Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -.
    • ComponentItemHierarchy; string; Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -.
    • ComponentSequenceId; integer; Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure.
    • ComponentType; number; Value that identifies the item as a component of a model. Value is 1.
    • ComponentYieldFactor; number; Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure.
    • ConfigItemId; integer; Value that uniquely identifies the item being assembled.
    • DateCreated; string; Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
    • DateDisabled; string; Date when the item or component is disabled.
    • EffectivityDate; string; Date when the item or component is effective.
    • HeaderId; integer; Value that uniquely identifies the match header.
    • InventoryItemDescription; string; Description of the line item.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item for the line item.
    • InventoryItemNumber; string; Number that identifies the line item.
    • ItemClassId; integer; Value that uniquely identifies the item class of the configured item component.
    • ItemClassName; string; Name of the item class of the configured item component.
    • ItemRevision; string; Revision of the item.
    • LineExplId; integer; Value that uniquely identifies the generated component item.
    • LineId; integer; Value that uniquely identifies the match detail record entry.
    • OptionalComponent; string; Contains one of the following values: Y or N. If Y, then the component is optional. If N, then the component is mandatory. The default value is N.
    • OrganizationCode; string; Abbreviation that identifies the organization of the inventory item.
    • OrganizationId; integer; Value that uniquely identifies the organization of the inventory item.
    • OrganizationName; string; Name of the inventory item organization.
    • ParentInventoryItemDescription; string; Description of the item in the parent inventory.
    • ParentInventoryItemId; integer; Value that uniquely identifies the item in the parent inventory.
    • ParentInventoryItemNumber; string; Name of the item in the parent inventory.
    • ParentLineId; integer; Value that uniquely identifies the line representing the immediate parent item for the component.
    • PlanningFactor; number; Factor used to multiply with the component quantity to obtain planning quantity.
    • RevisionId; integer; Value that uniquely identifies the item revision.
    • RootPhantomItemDescription; string; Description of phantom subassembly item.
    • RootPhantomItemId; integer; Value that uniquely identifies the phantom subassembly item.
    • RootPhantomItemNumber; string; Number that identifies the phantom subassembly item.
    • RoundingDirection; number; Rounding direction. Values include up or down. This is retrieved from the model structure.
    • SubItemType; integer; Value that identifies the type of structure. Valid values are 1, 2, or 4. The default value is 4. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
    • SubItemTypeName; string; Name of the type of structure. Valid values are Model, Option Class, or Standard. The default value is Standard. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
    • UnitOfMeasure; string; Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
    • UnitQuantity; number; Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
    • UnitUOM; string; Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
    • WIPSupplyType; integer; Value that identifies the type of supply that is work in progress. Values are 1, 2, 3, 4, 5, and 6. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
    • WIPSupplyTypeName; string; Name of the work in progress supply type of the component. Values are Assembly pull, Bulk, Operation pull, Phantom, Push, and Supplier. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
  • 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 : configuredItems-components-components
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : configuredItems-components-components-item-response
Type: object
Show Source
  • Read Only: true
    Value that identifies the component usage as fixed or variable. Value is 1. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Read Only: true
    Maximum Length: 80
    Value that identifies the component usage as fixed or variable. Value for items is variable component usage. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE.
  • Read Only: true
    Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
  • Read Only: true
    Identifies whether availability to promise (ATP) should be checked for component. Valid values include 1: Material only, 2: Material and Resource, 3: None, or 4: Resource only. The value is retrieved from the model structure. A list of accepted values is defined in the lookup type EGP_ORDATPCHECKVS_TYPE.
  • Maximum Length: 4000
    Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -.
  • Maximum Length: 4000
    Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -.
  • Read Only: true
    Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure.
  • Read Only: true
    Value that identifies the item as a component of a model. Value is 1.
  • Read Only: true
    Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure.
  • Read Only: true
    Value that uniquely identifies the item being assembled.
  • Read Only: true
    Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
  • Read Only: true
    Date when the item or component is disabled.
  • Read Only: true
    Date when the item or component is effective.
  • Read Only: true
    Value that uniquely identifies the match header.
  • Read Only: true
    Maximum Length: 240
    Description of the line item.
  • Read Only: true
    Value that uniquely identifies the inventory item for the line item.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the line item.
  • Read Only: true
    Value that uniquely identifies the item class of the configured item component.
  • Read Only: true
    Maximum Length: 80
    Name of the item class of the configured item component.
  • Read Only: true
    Maximum Length: 18
    Revision of the item.
  • Read Only: true
    Value that uniquely identifies the generated component item.
  • Read Only: true
    Value that uniquely identifies the match detail record entry.
  • Links
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: Y or N. If Y, then the component is optional. If N, then the component is mandatory. The default value is N.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization of the inventory item.
  • Read Only: true
    Value that uniquely identifies the organization of the inventory item.
  • Read Only: true
    Maximum Length: 240
    Name of the inventory item organization.
  • Read Only: true
    Maximum Length: 240
    Description of the item in the parent inventory.
  • Read Only: true
    Value that uniquely identifies the item in the parent inventory.
  • Read Only: true
    Maximum Length: 300
    Name of the item in the parent inventory.
  • Read Only: true
    Value that uniquely identifies the line representing the immediate parent item for the component.
  • Read Only: true
    Factor used to multiply with the component quantity to obtain planning quantity.
  • Read Only: true
    Value that uniquely identifies the item revision.
  • Read Only: true
    Maximum Length: 240
    Description of phantom subassembly item.
  • Read Only: true
    Value that uniquely identifies the phantom subassembly item.
  • Read Only: true
    Maximum Length: 300
    Number that identifies the phantom subassembly item.
  • Read Only: true
    Rounding direction. Values include up or down. This is retrieved from the model structure.
  • Read Only: true
    Value that identifies the type of structure. Valid values are 1, 2, or 4. The default value is 4. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
  • Read Only: true
    Maximum Length: 80
    Name of the type of structure. Valid values are Model, Option Class, or Standard. The default value is Standard. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE.
  • Read Only: true
    Maximum Length: 25
    Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
  • Read Only: true
    Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
  • Read Only: true
    Maximum Length: 3
    Value that uniquely identifies the bill sequence for the assemble to order (ATO) model. This is defined in the base model item structure.
  • Read Only: true
    Value that identifies the type of supply that is work in progress. Values are 1, 2, 3, 4, 5, and 6. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
  • Read Only: true
    Maximum Length: 80
    Name of the work in progress supply type of the component. Values are Assembly pull, Bulk, Operation pull, Phantom, Push, and Supplier. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
Back to Top