Retrieve Item Structure Details Using Structure Components Item Details
The REST API structureComponentsItemDetails enablesyou to
extract the structure details using Bill Sequence ID. In order to do so, you can create
a GET request in the following format:
Get Item Structure Details using ItemNumber and OrganizationCode
Let us say you are trying to get item structure details of Laptop 2050.
Example URL
Use this resource URL format.
POST
https://<hostName>/fscmRestApi/scm/redwood/11.13.18.05/structureComponentsItemsDetails?q=ItemNumber=Laptop 2050;OrganizationCode=V1;StructureViewName=StructureComponentDetailsView
Example Response
Here's an example of the response body in JSON format.
{
"structureComponentsItemsDetails": [
{
"SortOrder": "1",
"PlanLevel": "0",
"DotLevel": "0",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "null",
"ParentItemId": "null",
"ParentItemNumber": "null",
"BillSequenceId": "300100569482881",
"StructureItemId": "null",
"ComponentSequenceId": "null",
"ItemId": "100101496749358",
"ItemNumber": "Laptop 2050",
"Item": [
{
"Description": {
"US": "15 inch, touchscreen, black, "
},
"ItemNumber": "Laptop 2050",
"InventoryItemId": 100101496749358,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T19:02:02"
},
{
"Description": {
"US": "15 inch, touchscreen, black, "
},
"ItemNumber": "Laptop 2050",
"InventoryItemId": 100101496749358,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T19:02:02",
"EndEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "2",
"PlanLevel": "1",
"DotLevel": ".1",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "null",
"ParentItemId": "100101496749358",
"ParentItemNumber": "Laptop 2050",
"BillSequenceId": "300100569482881",
"StructureItemId": "100101496749358",
"ComponentSequenceId": "300100569482883",
"ItemId": "100101496749355",
"ItemNumber": "Keyboard standard",
"Component": [
{
"ComponentItemId": 100101496749355,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 30,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569482883
}
],
"Item": [
{
"Description": {
"US": "ASCII"
},
"ItemNumber": "Keyboard standard",
"InventoryItemId": 100101496749355,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T19:01:23"
},
{
"Description": {
"US": "ASCII"
},
"ItemNumber": "Keyboard standard",
"InventoryItemId": 100101496749355,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T19:01:23",
"EndEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "3",
"PlanLevel": "1",
"DotLevel": ".1",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "null",
"ParentItemId": "100101496749358",
"ParentItemNumber": "Laptop 2050",
"BillSequenceId": "300100569482881",
"StructureItemId": "100101496749358",
"ComponentSequenceId": "300100569482884",
"ItemId": "100101496749356",
"ItemNumber": "Display Screen LCD",
"Component": [
{
"ComponentItemId": 100101496749356,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 90,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569482884
}
],
"Item": [
{
"Description": {
"US": "15.6-in. display Full HD (1920X1080) "
},
"ItemNumber": "Display Screen LCD",
"InventoryItemId": 100101496749356,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T19:01:23"
},
{
"Description": {
"US": "15.6-in. display Full HD (1920X1080) "
},
"ItemNumber": "Display Screen LCD",
"InventoryItemId": 100101496749356,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T19:01:23",
"EndEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "4",
"PlanLevel": "1",
"DotLevel": ".1",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "null",
"ParentItemId": "100101496749358",
"ParentItemNumber": "Laptop 2050",
"BillSequenceId": "300100569482881",
"StructureItemId": "100101496749358",
"ComponentSequenceId": "300100569482882",
"ItemId": "100101496749357",
"ItemNumber": "Motherboard Assembly",
"Component": [
{
"ComponentItemId": 100101496749357,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 120,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569482882
}
],
"Item": [
{
"Description": {
"US": "16 GB, DDR4"
},
"ItemNumber": "Motherboard Assembly",
"InventoryItemId": 100101496749357,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
},
{
"Description": {
"US": "16 GB, DDR4"
},
"ItemNumber": "Motherboard Assembly",
"InventoryItemId": 100101496749357,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T19:01:23"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T19:01:23",
"EndEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "5",
"PlanLevel": "2",
"DotLevel": "..2",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "300100569482882",
"ParentItemId": "100101496749357",
"ParentItemNumber": "Motherboard Assembly",
"BillSequenceId": "300100569482839",
"StructureItemId": "100101496749357",
"ComponentSequenceId": "300100569477294",
"ItemId": "300100569477289",
"ItemNumber": "CPU 2050",
"Component": [
{
"ComponentItemId": 300100569477289,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 60,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569477294
}
],
"Item": [
{
"Description": {
"US": "11 Gen Intel Core i5-1135G7 "
},
"ItemNumber": "CPU 2050",
"InventoryItemId": 300100569477289,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
},
{
"Description": {
"US": "11 Gen Intel Core i5-1135G7 "
},
"ItemNumber": "CPU 2050",
"InventoryItemId": 300100569477289,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T19:05:08"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T19:05:08",
"EndEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "6",
"PlanLevel": "3",
"DotLevel": "...3",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "300100569477294",
"ParentItemId": "300100569477289",
"ParentItemNumber": "CPU 2050",
"BillSequenceId": "300100569477297",
"StructureItemId": "300100569477289",
"ComponentSequenceId": "300100569477418",
"ItemId": "300100569477402",
"ItemNumber": "PCB 2050",
"Component": [
{
"ComponentItemId": 300100569477402,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 60,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569477418
}
],
"Item": [
{
"Description": {
"US": "Matte Black"
},
"ItemNumber": "PCB 2050",
"InventoryItemId": 300100569477402,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:09:05"
},
{
"Description": {
"US": "Matte Black"
},
"ItemNumber": "PCB 2050",
"InventoryItemId": 300100569477402,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T20:09:05",
"EndEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"SortOrder": "7",
"PlanLevel": "4",
"DotLevel": "....4",
"OrganizationId": "204",
"StructureInternalName": "Primary",
"ParentComponentSequenceId": "300100569477418",
"ParentItemId": "300100569477402",
"ParentItemNumber": "PCB 2050",
"BillSequenceId": "300100569477408",
"StructureItemId": "300100569477402",
"ComponentSequenceId": "300100569477409",
"ItemId": "300100539462667",
"ItemNumber": "Fan",
"Component": [
{
"ComponentItemId": 300100539462667,
"PrimaryUomCode": {
"UnitOfMeasure": {
"KO": "[EachΩØ",
"US": "Each"
},
"UnitOfMeasureId": 539.0,
"UomCode": "Ea"
},
"ComponentQuantity": 1.0,
"ComponentOrganizationId": 204,
"ItemSequence": 30,
"WipSupplyType": {
"lookupCode": "1",
"meaning": {
"KO": "ΩPush 스'+Ø",
"US": "Push"
},
"lookupType": "EGP_WIP_SUP_TYPE"
},
"FindNumber": 1,
"ComponentSequenceId": 300100569477409
}
],
"Item": [
{
"Description": {
"US": "80mm x 80mm x 25mm 12V Brushless DC Cooling Fan"
},
"ItemNumber": "Fan",
"InventoryItemId": 300100539462667,
"OrganizationId": 204,
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2022-10-24T20:18:26"
},
{
"Description": {
"US": "80mm x 80mm x 25mm 12V Brushless DC Cooling Fan"
},
"ItemNumber": "Fan",
"InventoryItemId": 300100539462667,
"OrganizationId": 204,
"VersionEndDate": "2022-10-24T20:18:26",
"ItemCatalogGroupId": 100000011369001,
"VersionStartDate": "2020-09-23T10:11:52"
}
],
"ItemDefinitionOrgId": 204,
"ItemRevisionVersion": [
{
"StartEffectivityDate": "2020-09-23T10:11:52",
"EndEffectivityDate": "2022-10-24T20:18:26"
},
{
"StartEffectivityDate": "2022-10-24T20:18:26"
}
],
"ResultShapingItemEffACL": []
},
{
"Input": {
"ItemNumber": "Laptop 2050",
"MaxLevels": "{Default-ALL}",
"OrganizationCode": "V1",
"StructureName": "{Default-Primary}",
"StructureViewName": "StructureComponentDetailsView",
"UseDataSecurity": "{Default-Y}",
"ViewAsOfDate": "{Default-2025-12-16 18:37:00.0}"
}
}
]
}
This API supports GET requests. You must include Item Number and OrganizationCode as query parameters in your request. Alternatively, you can also include ItemId and OrganizationId as query parameters in the request.
This REST API also accepts the following query parameters:
| Name | Description | End Point |
| BillSequenceId | Bill Sequence Id of Parent Item | /fscmRestApi/scm/redwood/11.13.18.05/structureComponentsItemsDetails?q=BillSequenceId={BillSequenceId} |
| ItemId | Inventory Item Id of Parent Item | /fscmRestApi/scm/redwood/11.13.18.05/structureComponentsItemsDetails?q=ItemId={ItemId};OrganizationId={OrganizationId} |
| OrganizationId | Organization Id of Parent Item | |
| ItemNumber | Parent Item Number | /fscmRestApi/scm/redwood/11.13.18.05/structureComponentsItemsDetails?q=ItemNumber={ItemNumber};OrganizationCode={OrganizationCode} |
| OrganizationCode | Organization Code of Parent Item | |
| StructureName | Structure Name | If no value is provided, the default value is: Primary |
| MaxLevels | Max levels to extract BOM |
If no value is provided, gives all levels of item structure data. Note: You can only pass Integers, by default if you don't mention include this parameter you will get all levels data. |
| ViewAsOfDate | Context date to get the item revisions |
If no value is providied, default value is the current time Note: Date should be in the following format: YYYY-MM-DDTHH:MM:SS |
| UseDataSecurity | Use data security |
If no value is provided, default value is Y Note: It accepts Y or N |
| StructureViewName | View name defined in the structure grid | If no value is provided, the Structure view name configured as default in the Structure grid for TaskFlow=Item Structure and Application=Product Management is considered. |
Note:
These error codes and details help you debug issues:
| Error Code | Error Details |
| EGP_NO_PRIV_ITEM | You need permission to view the item. |
| EGP_INVLD_SEARCH_FIELD_VALUE | Search criteria aren't valid. Run the query again with valid criteria. |
| EGP_INDEX_VIEW_NOT_FOUND | Structure doesn't contain the {VIEW_NAME} view. |
| EGP_INDEX_RESPONSE_PROCESS_ER | Response for the index can't be processed. |
| EGP_INDEX_RESPONSE_NOT_FOUND | Response for the index can't be found. |
| EGP_INVLD_SEARCH_FIELDS | Search lookup parameters aren't valid. Run the query again with valid details. |
| EGP_INVLD_SEARCH_FIELD_NAME | Field name isn't valid. Run the query again with a valid field name. |
| EGP_ITEM_STRUCT_NOT_FOUND | Item structure wasn't found. |
| EGP_ITM_STR_INVLD_LOOKUP_INFO | Structure lookup details aren't valid. Run the query again with valid details. |
| EGP_ITEM_INVLD_LOOKUP_INFO | Item lookup details aren't valid. Run the query again with valid details. |
| EGP_INDEX_DFLT_VIEW_NOT_FOUND | Default view for the index is unavailable on the structure and the StructureViewName parameter is missing in your query. |
| EGP_INDEX_VIEW_ATTR_NOT_FOUND | Index view attributes are unavailable in the {VIEW_NAME} view. |
Access Requirements
Users who are assigned a configured job role that contains these privileges can access this feature:
For Items:
- EGP_VIEW_REDWOOD_ITEM_PRIV
- EGP_VIEW_ITEM_PRIV
- EGP_MANAGE_REDWOOD_ITEM_PRIV
For Item Structures:
- EGP_VIEW_REDWOOD_ITEM_STRUCTURE_PRIV
- EGP_MANAGE_REDWOOD_ITEM_STRUCTURE_PRIV