Retrieve Structure Details Using Rest API

A new REST API structureComponentsItemsDetails is introduced to retrieve structure component details based on the Structure view.

Using this REST API, the user can get structure component information by passing ItemNumber, OrganizationCode, and Structure View Name as query parameters

Sample to Invoke the REST API

You can also specify the following additional nonmandatory query parameters in your request URL:

• StructureName - For example: Primary or Planning. If no structure name is specified, then the primary structure details will be returned by default.
• MaxLevels - Retrieve multi-level structure details or a certain level.
• VersionDate - Query for structure as of a specified date.

This feature benefits your business by the following:

• Enhances access to your data by enabling an additional method to retrieve structure details programmatically and near real-time. 
• Streamlines data access by allowing users to specify a view name to automatically return all relevant attributes grouped within a view.
• Establishes an efficient manner in which to retrieve data by eliminating the need to manually define each attribute that needs to be retrieved, thereby simplifying how information is retrieved and analyzed.

Steps to Enable and Configure

You can configure the structure view by following the instructions provided in Access Predefined Views

Tips And Considerations

• You must configure a structure view before invoking this REST API to get meaningful data.
• If you don't pass the view name, then the API will return standard attributes.
• There is no limit for the number of rows returned in the response.

Key Resources

• You can access the use case document from Product Management Use Cases 

Access Requirements

Users who are assigned a configured job role that contains these privileges can access this feature:

• To view the item structure using the REST API:
  • View Item Redwood Structures (EGP_VIEW_REDWOOD_ITEM_STRUCTURE_PRIV)  OR
  • Manage Item Redwood Structures (EGP_MANAGE_REDWOOD_ITEM_STRUCTURE_PRIV)