Get one component
get
/fscmRestApi/resources/11.13.18.05/configuredItems/{LineExplId}/child/components/{LineExplId2}
Request
Path Parameters
-
LineExplId(required): integer(int64)
Value that uniquely identifies the generated configured item.
-
LineExplId2(required): integer(int64)
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
-
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : configuredItems-components-item-response
Type:
Show Source
object
-
BasisType: integer
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. -
BasisTypeDescription: string
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. -
BillSequenceId: integer
(int64)
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. -
CheckATP: number
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. -
ComponentHierarchy: string
Maximum Length:
4000
Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -. -
ComponentItemHierarchy: string
Maximum Length:
4000
Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -. -
components: array
Components
Title:
Components
The Components resource manages the items that make up the structure of the configured item. -
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure. -
ComponentType: number
Read Only:
true
Value that identifies the item as a component of a model. Value is 1. -
ComponentYieldFactor: number
Read Only:
true
Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure. -
ConfigItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item being assembled. -
ConfigItemVersion: integer
(int32)
Read Only:
true
Number that uniquely identifies the one-time configured item version. -
DateCreated: string
(date)
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. -
DateDisabled: string
(date)
Read Only:
true
Date when the item or component is disabled. -
EffectivityDate: string
(date)
Read Only:
true
Date when the item or component is effective. -
HeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the match header. -
InventoryItemDescription: string
Read Only:
true
Maximum Length:240
Description of the line item. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item for the line item. -
InventoryItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the line item. -
ItemClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item class of the configured item component. -
ItemClassName: string
Read Only:
true
Maximum Length:80
Name of the item class of the configured item component. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Revision of the item. -
LineExplId: integer
(int64)
Read Only:
true
Value that uniquely identifies the generated component item. -
LineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the match detail record entry. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OneTimeConfigFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then the configured item component is a one-time configured item. If N, then the configured item component isn't a one-time configured item. The default value is N. -
OptionalComponent: string
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. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization of the inventory item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization of the inventory item. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory item organization. -
ParentInventoryItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item in the parent inventory. -
ParentInventoryItemId: integer
Read Only:
true
Value that uniquely identifies the item in the parent inventory. -
ParentInventoryItemNumber: string
Read Only:
true
Maximum Length:300
Name of the item in the parent inventory. -
ParentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line representing the immediate parent item for the component. -
PlanningFactor: number
Read Only:
true
Factor used to multiply with the component quantity to obtain planning quantity. -
RevisionId: integer
Read Only:
true
Value that uniquely identifies the item revision. -
RootPhantomItemDescription: string
Read Only:
true
Maximum Length:240
Description of phantom subassembly item. -
RootPhantomItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the phantom subassembly item. -
RootPhantomItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the phantom subassembly item. -
RoundingDirection: number
Read Only:
true
Rounding direction. Values include up or down. This is retrieved from the model structure. -
SubItemType: integer
(int64)
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. -
SubItemTypeName: string
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. -
substitutes: array
Substitutes
Title:
Substitutes
The Substitutes resource manages the items that are set up as substitutes for the components. -
transactionalAttributes: array
Transactional Attributes
Title:
Transactional Attributes
The Transactional Attributes resource manages the item attributes that are unique to the configuration at any level of the model. -
UnitOfMeasure: string
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. -
UnitQuantity: number
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. -
UnitUOM: string
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. -
WIPSupplyType: integer
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. -
WIPSupplyTypeName: string
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.
Nested Schema : Components
Type:
array
Title:
Components
The Components resource manages the items that make up the structure of the configured item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Substitutes
Type:
array
Title:
Substitutes
The Substitutes resource manages the items that are set up as substitutes for the components.
Show Source
Nested Schema : Transactional Attributes
Type:
array
Title:
Transactional Attributes
The Transactional Attributes resource manages the item attributes that are unique to the configuration at any level of the model.
Show Source
Nested Schema : configuredItems-components-components-item-response
Type:
Show Source
object
-
BasisType: integer
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. -
BasisTypeDescription: string
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. -
BillSequenceId: integer
(int64)
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. -
CheckATP: number
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. -
ComponentHierarchy: string
Maximum Length:
4000
Hierarchy of the component. The unique identifiers of the value are separated by the delimiter -. -
ComponentItemHierarchy: string
Maximum Length:
4000
Hierarchy of inventory item. The unique identifiers of the value are separated by the delimiter -. -
ComponentSequenceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the component sequence for the selected component. This is defined in the base model item structure. -
ComponentType: number
Read Only:
true
Value that identifies the item as a component of a model. Value is 1. -
ComponentYieldFactor: number
Read Only:
true
Factor used to multiply with the component quantity to obtain component quantity. This is retrieved from the model structure. -
ConfigItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item being assembled. -
ConfigItemVersion: integer
(int32)
Read Only:
true
Number that uniquely identifies the one-time configured item version. -
DateCreated: string
(date)
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. -
DateDisabled: string
(date)
Read Only:
true
Date when the item or component is disabled. -
EffectivityDate: string
(date)
Read Only:
true
Date when the item or component is effective. -
HeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the match header. -
InventoryItemDescription: string
Read Only:
true
Maximum Length:240
Description of the line item. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item for the line item. -
InventoryItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the line item. -
ItemClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item class of the configured item component. -
ItemClassName: string
Read Only:
true
Maximum Length:80
Name of the item class of the configured item component. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Revision of the item. -
LineExplId: integer
(int64)
Read Only:
true
Value that uniquely identifies the generated component item. -
LineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the match detail record entry. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OneTimeConfigFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then the configured item component is a one-time configured item. If N, then the configured item component isn't a one-time configured item. The default value is N. -
OptionalComponent: string
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. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization of the inventory item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization of the inventory item. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory item organization. -
ParentInventoryItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item in the parent inventory. -
ParentInventoryItemId: integer
Read Only:
true
Value that uniquely identifies the item in the parent inventory. -
ParentInventoryItemNumber: string
Read Only:
true
Maximum Length:300
Name of the item in the parent inventory. -
ParentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line representing the immediate parent item for the component. -
PlanningFactor: number
Read Only:
true
Factor used to multiply with the component quantity to obtain planning quantity. -
RevisionId: integer
Read Only:
true
Value that uniquely identifies the item revision. -
RootPhantomItemDescription: string
Read Only:
true
Maximum Length:240
Description of phantom subassembly item. -
RootPhantomItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the phantom subassembly item. -
RootPhantomItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the phantom subassembly item. -
RoundingDirection: number
Read Only:
true
Rounding direction. Values include up or down. This is retrieved from the model structure. -
SubItemType: integer
(int64)
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. -
SubItemTypeName: string
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. -
UnitOfMeasure: string
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. -
UnitQuantity: number
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. -
UnitUOM: string
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. -
WIPSupplyType: integer
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. -
WIPSupplyTypeName: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : configuredItems-components-substitutes-item-response
Type:
Show Source
object
-
ConfigItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item being assembled. -
InventoryItemDescription: string
Read Only:
true
Maximum Length:240
Description of the line item. -
InventoryItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item for the line item. -
InventoryItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the line item. -
ItemClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item class of the configured item component. -
ItemClassName: string
Read Only:
true
Maximum Length:80
Name of the item class of the configured item component. -
LineExplId: integer
(int64)
Read Only:
true
Value that uniquely identifies the generated substitute item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the line representing the immediate parent item for the component. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Unit of measure for the quantity specified. -
UnitQuantity: number
Read Only:
true
Required quantity to make one unit of the top level assembly. -
UnitUOM: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the quantity specified.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : configuredItems-components-transactionalAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Read Only:
true
Maximum Length:100
Name of the transactional item attribute. -
CharacterAttributeValue: string
Read Only:
true
Maximum Length:50
Character value of transactional item attribute. -
DateAttributeValue: string
(date)
Read Only:
true
Date value of the transactional item attribute. -
LineId: integer
Read Only:
true
Value that uniquely identifies the immediate parent item for the attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatchTransactionAttrId: integer
(int64)
Read Only:
true
Value that uniquely identifies the transactional item attribute. -
NumberAttributeValue: integer
(int64)
Read Only:
true
Numeric value of the transactional item attribute. -
TimestampAttributeValue: string
(date-time)
Read Only:
true
Date and time value of the transactional item attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- components
-
Parameters:
- LineExplId:
$request.path.LineExplId
- LineExplId2:
$request.path.LineExplId2
The Components resource manages the items that make up the structure of the configured item. - LineExplId:
- substitutes
-
Parameters:
- LineExplId:
$request.path.LineExplId
- LineExplId2:
$request.path.LineExplId2
The Substitutes resource manages the items that are set up as substitutes for the components. - LineExplId:
- transactionalAttributes
-
Parameters:
- LineExplId:
$request.path.LineExplId
- LineExplId2:
$request.path.LineExplId2
The Transactional Attributes resource manages the item attributes that are unique to the configuration at any level of the model. - LineExplId:
Examples
This example describes how to get one component.
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/configuredItems/LineExplId/child/components/LineExplId2"
For example, the following command gets one component where LineExplId2 is 8628:
curl -u username:password "https://servername/fscmRestApi/resources/version/configuredItems/8618/child/components/8628"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ConfigItemId" : 300100112091239, "RevisionId" : null, "InventoryItemId" : 100100002133779, "ItemRevision" : null, "InventoryItemNumber" : "STOVE_UNIT", "InventoryItemDescription" : "Base Stove Unit", "ItemClassId" : 100000011369001, "ItemClassName" : "Root Item Class", "ParentInventoryItemId" : 300100112091239, "ParentInventoryItemNumber" : "10001", "ParentInventoryItemDescription" : "Standard Custom Viking Stove ATO Model", "HeaderId" : 300100112091258, "LineId" : 300100061846459, "ParentLineId" : 300100112091259, "SubItemType" : 4, "SubItemTypeName" : "Standard", "UnitQuantity" : 1, "UnitUOM" : "Ea", "UnitOfMeasure" : "Each", "DateCreated" : "2017-07-21", "EffectivityDate" : "2015-03-23", "DateDisabled" : null, "OrganizationId" : 209, "OrganizationCode" : "M2", "OrganizationName" : "Tall Manufacturing", "BillSequenceId" : 300100061846451, "ComponentSequenceId" : 300100061846459, "ComponentType" : -1, "WIPSupplyType" : null, "WIPSupplyTypeName" : null, "OptionalComponent" : "N", "ComponentYieldFactor" : 1, "PlanningFactor" : 100, "RoundingDirection" : 1, "BasisType" : 1, "CheckATP" : 2, "ComponentHierarchy" : "300100061846451-300100061846459", "ComponentItemHierarchy" : "300100112091239-100100002133779", "RootPhantomItemId" : null, "LineExplId" : 8628, "RootPhantomItemNumber" : null, "RootPhantomItemDescription" : null, "BasisTypeDescription" : "Variable", "transactionalAttributes" : [ ], "substitutes" : [ ], "links" : [ { "rel" : "self", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components/8628", "name" : "components", "kind" : "item" }, { "rel" : "canonical", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components/8628", "name" : "components", "kind" : "item" }, { "rel" : "parent", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618", "name" : "configuredItems", "kind" : "item" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components/8628/child/transactionalAttributes", "name" : "transactionalAttributes", "kind" : "collection" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components/8628/child/substitutes", "name" : "substitutes", "kind" : "collection" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components/8628/child/components", "name" : "components", "kind" : "collection" } ] }