1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Item Structures

Get all structures

get

/fscmRestApi/resources/11.13.18.05/itemStructures

Request

Query Parameters
  • 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:

    • AltKey: Find item structures according to the alternate key.
      Finder Variables:
      • AlternateBOMDesignator; string; Value that identifies the alternate designator.
      • ItemId; string; Value that uniquely identifies the item.
      • OrganizationId; string; Value that uniquely identifies the organization.
    • PrimaryKey: Find item structures according to the primary key.
      Finder Variables:
      • BillSequenceId; integer; Value that uniquely identifies the structure. This is a read-only field that you can modify only if the resource is already modified.
  • 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:
    • AlternateBOMDesignator; string; Alternate designator for the item structure.
    • BillSequenceId; integer; Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
    • ChangeNotice; string; Change order notice to which the service operation added all the structure component changes. This attribute is read-only.
    • CommonBillSequenceId; integer; Value that uniquely identifies the common bill of materials.
    • CommonItemNumber; string; Number that identifies the item for the common structure. This attribute is read-only.
    • CommonOrganizationCode; string; Name of the organization for the common structure. This attribute is read-only.
    • CreatedBy; string; User who created the structure.
    • CreationDateTime; string; Date and time when the structure was created.
    • Description; string; Description of the structure.
    • EffectivityControl; integer; Value that indicates the way effectivity is controlled within a structure. Valid values include Date, Unit Number, or Serial Number.
    • EffectivityControlValue; string; Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
    • ItemId; string; Value that uniquely identifies the part, item, product, or service.
    • ItemNumber; string; Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
    • LastUpdateDateTime; string; Date and time when the structure was most recently updated.
    • LastUpdateLogin; string; Login of the user who most recently updated the item structure.
    • LastUpdatedBy; string; User who most recently updated the structure.
    • OrganizationCode; string; Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
    • OrganizationId; string; Value that uniquely identifies the organization.
    • OriginalSystemReference; string; Value that indicates the authoring application responsible for managing the record. If it is empty, the record is managed by the user from the standard user interface.
    • RequestId; integer; Request ID generated at import. Its use case is to verify import. The items are published based on the RequestID.
    • SourceItemNumber; string; Number that identifies the source application item from which the structure is created. This attribute is read-only.
    • SourceOrganizationCode; string; Abbreviation that identifies the source organization from which the structure is created. This attribute is read-only.
    • StructureName; string; Name of the structure. This attribute is read-only, which can be modified for the create operation.
  • 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 : itemStructures
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : itemStructures-item-response
Type: object
Show Source
  • Title: Name
    Maximum Length: 80
    Alternate designator for the item structure.
  • Read Only: true
    Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
  • Read Only: true
    Change order notice to which the service operation added all the structure component changes. This attribute is read-only.
  • Value that uniquely identifies the common bill of materials.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Number that identifies the item for the common structure. This attribute is read-only.
  • Read Only: true
    Maximum Length: 18
    Name of the organization for the common structure. This attribute is read-only.
  • Components
    Title: Components
    The Components resource manages the details of a component within a structure.
  • Read Only: true
    Maximum Length: 64
    User who created the structure.
  • Read Only: true
    Date and time when the structure was created.
  • Title: Description
    Maximum Length: 240
    Description of the structure.
  • Title: Effectivity Control
    Value that indicates the way effectivity is controlled within a structure. Valid values include Date, Unit Number, or Serial Number.
  • Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
  • Expansions of Item Structures
    Title: Expansions of Item Structures
    The Expansions of Item Structures resource breaks apart each assembly or subassembly into it's component parts.
  • Maximum Length: 240
    Value that uniquely identifies the part, item, product, or service.
  • Number that identifies a part, material, product, or service. This attribute is read-only, which can be modified for the create operation.
  • Read Only: true
    Date and time when the structure was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the structure.
  • Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the item structure.
  • Links
  • Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
  • Maximum Length: 240
    Value that uniquely identifies the organization.
  • Maximum Length: 50
    Value that indicates the authoring application responsible for managing the record. If it is empty, the record is managed by the user from the standard user interface.
  • Read Only: true
    Request ID generated at import. Its use case is to verify import. The items are published based on the RequestID.
  • Title: Item
    Read Only: true
    Maximum Length: 300
    Number that identifies the source application item from which the structure is created. This attribute is read-only.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the source organization from which the structure is created. This attribute is read-only.
  • Item Structure Attachments List of Values
    Title: Item Structure Attachments List of Values
    The list of values includes details of the attachments for the structure header. For example, attachment document ID and last upload date.
  • Flexfields for Item Structures
    Title: Flexfields for Item Structures
    The Flexfields for Item Structures resource gets the descriptive flexfields associated with the item structure.
  • Name of the structure. This attribute is read-only, which can be modified for the create operation.
Nested Schema : Components
Type: array
Title: Components
The Components resource manages the details of a component within a structure.
Show Source
Nested Schema : Expansions of Item Structures
Type: array
Title: Expansions of Item Structures
The Expansions of Item Structures resource breaks apart each assembly or subassembly into it's component parts.
Show Source
Nested Schema : Item Structure Attachments List of Values
Type: array
Title: Item Structure Attachments List of Values
The list of values includes details of the attachments for the structure header. For example, attachment document ID and last upload date.
Show Source
Nested Schema : Flexfields for Item Structures
Type: array
Title: Flexfields for Item Structures
The Flexfields for Item Structures resource gets the descriptive flexfields associated with the item structure.
Show Source
Nested Schema : itemStructures-Component-item-response
Type: object
Show Source
  • Title: Absolute Yield
    Read Only: true
    Represents the absolute yield of a component. This value equals to quantity times yield.
  • Title: Change Action
    Read Only: true
    Default Value: 1
    Identifies whether the component is being added, modified, or deleted in a change line.
  • Read Only: true
    Maximum Length: 255
    Value that indicates if the substitute component is being added, modified, or deleted through a change line.
  • Title: Automatically Request Material
    Maximum Length: 1
    Default Value: true
    Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.
  • Title: Basis
    Default Value: 1
    Value that indicates if the option class quantity can be overridden by sales order. Valid values include None (can override) or Option Class (cannot override).
  • Value that determines if the option class quantity can be overridden by the sales order. Valid values include None or Option Class.
  • Value that uniquely identifies the structure.
  • Identifies the change order to which the pending component has been added.
  • Read Only: true
    Default Value: -1
    Value that uniquely identifies the revised change line to which pending component is added.
  • Read Only: true
    Maximum Length: 255
    Change order notice to which the pending component is added.
  • Title: Check ATP
    Default Value: false
    Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.
  • Title: Comments
    Maximum Length: 4000
    Comments about a component.
  • Title: Formula Name
    Maximum Length: 80
    Indicates the context formula for an ingredient.
  • Title: Completion Type
    Maximum Length: 30
    Indicates how the output item will be reported during work execution.
  • Maximum Length: 255
    Value used by the manufacturer to define the completion type of products. The values are Automatic, Manual, or None.
  • Flexfields for Components
    Title: Flexfields for Components
    The Flexfields for Components resource gets the descriptive flexfields associated with the component.
  • Read Only: true
    Maximum Length: 255
    Class of the component item. This attribute is read-only and is not required for an update operation.
  • Maximum Length: 240
    Value that uniquely identifies the item associated with the component.
  • Number that indicates the item of a component. This attribute is read-only, which can be modified for the create operation.
  • Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
  • Title: Material Type
    Maximum Length: 30
    Default Value: INPUT
    Indicates the type of material for the formula.
  • Maximum Length: 255
    Indicates the type of material. The values include Ingredient or Product.
  • Title: Contribute to Yield
    Maximum Length: 30
    Indicates whether the ingredient quantity should contribute to the yield.
  • Maximum Length: 255
    Value used by the manufacturer to define the contribution to the yield of ingredients. The values include Yes, No, or None.
  • Read Only: true
    Maximum Length: 64
    User who created the component.
  • Read Only: true
    Date and time when the structure was created.
  • Title: End Date
    Date and time when a component in a structure ends.
  • Value that is used by planning to generate the demand in integer quantities. Values include Round Up, Round Down, or None.
  • Title: Enforce Integer Requirement
    Default Value: 0
    Value that is used by Oracle Supply Planning Cloud to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
  • Title: Find Number
    Default Value: 1
    Number used to locate a specific instance of an item in a structure.
  • Title: From End Item Unit Number
    Maximum Length: 30
    Number that indicates the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
  • Title: Effective Date
    Read Only: true
    Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.
  • Title: Include on Shipping Documents
    Default Value: false
    Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.
  • Title: Instantiability
    Maximum Length: 30
    Abbreviation that identifies the whether a component item is instantiable in an item structure.
  • Value that indicates whether a component item is instantiable in an item structure.
  • Title: Item Sequence
    Number that defines the sequence of components in a structure.
  • Read Only: true
    Date and time when the structure was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the component.
  • Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the component.
  • Links
  • Title: Maximum Quantity
    Value that indicates the maximum order quantity.
  • Title: Minimum Quantity
    Value that indicates the minimum order quantity.
  • Title: Mutually Exclusive
    Default Value: false
    Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.
  • Read Only: true
    Reference to the production row when the component is modified in a change line.
  • Title: Optional
    Default Value: false
    Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.
  • Maximum Length: 240
    Value that uniquely identifies the organization.
  • Title: Planning Percent
    Default Value: 100
    Distribution percentage for a component. It is used by forecast planning.
  • Maximum Length: 30
    Primary unit of measure for the item quantities.
  • Maximum Length: 255
    Value that indicates the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.
  • Read Only: true
    Maximum Length: 255
    Value in the primary unit of measure for the item quantities.
  • Title: Product Type
    Maximum Length: 30
    Indicates the type of product for the formula output.
  • Maximum Length: 255
    Indicates the product type. The values include Primary, Co-Product, or By-Product. There's only one primary product in a formula.
  • Title: Quantity
    Default Value: 1
    Quantity of component item that is used.
  • Title: Quantity Related
    Default Value: false
    Value that indicates whether a component is quantity related or not. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
  • Reference Designators
    Title: Reference Designators
    The Reference Designators resource manages the details of a reference designator.
  • Maximum Length: 255
    Item number of the replacement component.
  • New find number value of the replacement component.
  • Read Only: true
    Maximum Length: 255
    Item number of the component that's being replaced.
  • Title: Required for Revenue
    Default Value: false
    Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.
  • Title: Required to Ship
    Default Value: false
    Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.
  • Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
  • Value that indicates if the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
  • Value that indicates if the component is visible in the sales application. Values include Yes, Hide Self, and Hide Self and Descendants.
  • Title: Sales Order Basis
    Default Value: 2
    Value that indicates the basis to override the default quantity for the option class when a sales order is entered (the default), for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
  • Title: Start Date
    Date and time when a component in a structure begins.
  • Substitute Components
    Title: Substitute Components
    The Substitute Components resource manages the details of a substitute component.
  • Title: Suggested Operation Sequence
    Sequence number suggested by a design engineer for a specific component operation in a manufacturing work definition. Example values are 10, 20, 30, and so on.
  • Type of supply for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
  • Title: Use Placeholder
    A flag indicating if this Option Class item data should be loaded into configurator models.
  • Where Used for Item Structures
    Title: Where Used for Item Structures
    The Where Used for Item Structures resource gets the items in which this structure is used.
  • Title: Supply Type
    Type of supply for components.
  • Title: Yield
    Default Value: 1
    Value that indicates the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.
Nested Schema : Flexfields for Components
Type: array
Title: Flexfields for Components
The Flexfields for Components resource gets the descriptive flexfields associated with the component.
Show Source
Nested Schema : Reference Designators
Type: array
Title: Reference Designators
The Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Substitute Components
Type: array
Title: Substitute Components
The Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : Where Used for Item Structures
Type: array
Title: Where Used for Item Structures
The Where Used for Item Structures resource gets the items in which this structure is used.
Show Source
Nested Schema : itemStructures-Component-ComponentDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-item-response
Type: object
Show Source
Nested Schema : Flexfields for Reference Designators
Type: array
Title: Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator.
Show Source
Nested Schema : itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-item-response
Type: object
Show Source
Nested Schema : Flexfields for Substitute Components
Type: array
Title: Flexfields for Substitute Components
The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component.
Show Source
Nested Schema : itemStructures-Component-SubstituteComponent-SubstituteComponentDFF-item-response
Type: object
Show Source
Nested Schema : itemStructures-Component-WhereUsed-item-response
Type: object
Show Source
  • Maximum Length: 80
    Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.
  • Value that uniquely identifies the parent structure.
  • Maximum Length: 240
    Description of the item of a component.
  • Maximum Length: 300
    Number that indicates the item of a component.
  • Maximum Length: 4000
    Value that represents the hierarchical path of a component item to the root item in a structure.
  • Value that uniquely identifies the component in a structure.
  • Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
  • Date and time when a component in a structure ends.
  • Maximum Length: 30
    Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.
  • Maximum Length: 30
    Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.
  • Maximum Length: 250
    Name in metadata that is common to all items that share the category.
  • Maximum Length: 240
    Value that defines codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled.
  • Maximum Length: 80
    Value that indicates grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes.
  • Links
  • Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
  • Value that uniquely identifies the parent structure.
  • Number that uniquely identifies the parent identifier for a part, material, product, or service.
  • Quantity of a component in a structure.
  • Date and time when a component in a structure begins.
  • Name of the structure. This attribute is read-only, which can be modified for the create operation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item is the top item where this component is used. If false, then the item is not the top item where this component is used. The default value is false.
  • Maximum Length: 30
    Number that identifies the item serial up to which the component is effective in a structure.
  • Maximum Length: 30
    Number that identifies the item unit up to which the component is effective.
Nested Schema : itemStructures-Expansion-item-response
Type: object
Show Source
  • Read Only: true
    Value that indicates to check the following information when placing a demand: available to promise and capable to promise.
  • Title: Available to Promise
    Maximum Length: 1
    Value that indicates to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
  • Read Only: true
    Value that indicates to check additional components in the bill of material of assemble-to-order and pick-to-order items when running the available to promise checks.
  • Title: Available to Promise
    Maximum Length: 1
    Value that indicates to check available to promise and or capable to promise information when placing demand.
  • Title: Automatically Request Material
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a move order is automatically created for a material in a work order release. If false, then a move order is not automatically created. The default value is true.
  • Title: Basis
    Value that indicates that the option class quantity can be overridden by a sales order. Valid values include None, can override, or Option Class, can't override.
  • Value that identifes that the option class quantity can be overridden by a sales order. Valid values include None or Option Class.
  • Title: Check ATP
    Contains one of the following values: true or false. If true, then check the following when placing the demand: available to promise and capable to promise. If false, then do not check. The default value is true.
  • Title: Comments
    Maximum Length: 240
    Comments about a component.
  • Value that uniquely identifies a component in a structure.
  • Maximum Length: 240
    Value that uniquely identifies the item associated with the component.
  • Maximum Length: 40
    Number that identifies the item of a component.
  • Maximum Length: 4000
    Value that identifies the hierarchical path of a component item to the root item in a structure.
  • Value that uniquely identifies a component in a structure.
  • Title: Path
    Maximum Length: 32767
    Value that identifies the hierarchical path or linage of a component item to the root item in a structure using the component sequence IDs.
  • Value that identifies whether the component sub-assembly is date effective or is model or unit effetive.
  • Maximum Length: 255
    Value that identifies the component's own unit of measurement as used in a bill of materials. This may be different from the item's own unit of measurement. An example would be Wooden Panels used in the construction of a piece of furniure e.g. a Table. The wooden panel's unit of measurement may be "Box" , but it may have a unit of measurement "Each" when used as component of a table.
  • Title: Customer Orders Enabled
    Maximum Length: 1
    Value that indicates that an item is currently customer orderable.
  • Title: Customer Ordered
    Maximum Length: 1
    Value that indicates that an item can be ordered by external customers.
  • Title: End Date
    Date and time when a component in a structure ends.
  • Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
  • Title: Enforce Integer Requirement
    Value that is used by Oracle Supply Planning to generate the demand in integer quantities. Valid values include Round Up, Round Down, or None.
  • Read Only: true
    Value that identifies how model subassemblies are handled. If the the value is true, then the model subassemblies will be exploded.
  • Read Only: true
    Value that identifies the expansion operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current).
  • Read Only: true
    Value that identifies the structure expansion operation for date effective structures.
  • Read Only: true
    Value that identifies the expansion type. The value include, 1 Optional, 2 Included, or 3 Both. The default value is 3 Both.
  • Value that identifies the calculated total quantity of the component used in the whole explosion.
  • Title: Find Number
    Read Only: true
    An attribute value that holds find number for the component.
  • Title: From End Item Unit Number
    Maximum Length: 30
    Number that identifies the item unit or serial from which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the item serial from which the component is effective in a structure. It's valid only for serial effective structures.
  • Read Only: true
    Maximum Length: 30
    Number that identifies the item unit from which the component is effective. It is valid only for unit effective structures.
  • Title: Effective Date
    Date and time when the component was implemented in production. It displays NULL for pending components. You can use this value to differentiate between pending and production components.
  • Read Only: true
    Value that identifies how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of the explosion process.
  • Title: Include on Shipping Documents
    Contains one of the following values: true or false. If true, then the component is displayed on shipping documentation. If false, then the component is not displayed. The default value is true.
  • Maximum Length: 30
    Abbreviation that identifies whether a component item is instantiable in an item structure.
  • Value that indicates that a component item is instantiable in an item structure.
  • Title: Transfer Orders Enabled
    Maximum Length: 1
    Value indicating that an item can be ordered on an internal requisition.
  • Title: Internally Transferable
    Maximum Length: 1
    Value indicating that an Item can be ordered internally.
  • Value that identifies the inverse of an exact or specified quantity defined for a structure component.
  • Name in metadata that is common to all items that share the category.
  • Title: Item Sequence
    Number that idenfitifies the sequence of components in a structure.
  • Maximum Length: 30
    Value that identifies the codes used to control the transaction activity of an item. For example, an item in active status can be customer-order enabled.
  • Links
  • Title: Maximum Quantity
    Value that identifies the maximum order quantity.
  • Title: Minimum Quantity
    Value that identifies the minimum order quantity.
  • Title: Mutually Exclusive
    Contains one of the following values: true or false. If true, then one or more options under this option class can be selected. If false, then you cannot select any options. The default value is true.
  • Title: Optional
    Contains one of the following values: true or false. If true, then the component is optional for a structure. If false, then the component is not optional. The default value is true.
  • Abbreviation that identifies the name of an organizing unit in the internal or external organization structure of your enterprise. Organization structure provides the framework for performing legal reporting, financial control, and management reporting. This attribute is read-only, which can be modified for the create operation.
  • Maximum Length: 240
    Value that uniquely identifies the organization.
  • Value that uniquely identifies the parent structure.
  • Value that uniquely identifies the parent bill structure.
  • Maximum Length: 32767
    Value that identifies the hierarchical path or linage of a parent component item to the root item in a structure using the component sequence IDs.
  • Abbreviation that identifies the way effectively is controlled within the parent of the structure.
  • Value that identifies the way effectivety is controlled within the parent of the structure. The values include Date, Unit Number, or Serial Number.
  • Maximum Length: 240
    Value that uniquely identifies the parent of an identifier for a part, material, product, or service that is unique as compared with other items, by the nature of its attributes.
  • Number that uniquely identifies the parent identifier for a part, material, product, or service.
  • Title: Description
    Maximum Length: 240
    Value that identifies the description of a parent structure.
  • Value that indicates whether the structure is date effective or is model or unit effetive.
  • Maximum Length: 255
    Value that identifies the name of a parent structure.
  • Title: Pick Components
    Value indicating that an item has a structure l with options, classes, or included items picked from finished goods inventory.
  • Value which indicates the depth of the node, row, in the exploded tree. For example, a value of 0 denotes that it is the root node.
  • Title: Planning Percent
    Value that identifies the distribution percentage for a component. It is used by forecast planning.
  • Maximum Length: 3
    Value that identifies the primary unit of measure for the item quantities.
  • Maximum Length: 255
    Value that identifies the unit of measure of a component in a bill of materials. This may be different from the unit of measure of the item. For example, wooden panels used in the making of a table. The unit of measure of the wooden panel can be Box; however, when used as the component of a table, the unit of measurement can be Each.
  • Title: Quantity
    Value that identifies quantity of a component in a structure.
  • Title: Quantity Related
    Value that indicates that a component is quantity related. If enabled, the application validates whether the specified quantity matches the number of reference designators on the component.
  • Title: Assemble to Order
    Maximum Length: 1
    Value that indicates the generally built for sales order demand; a final assembly work order is created based on sales order details.
  • Title: Required for Revenue
    Contains one of the following values: true or false. If true, then the component is required to recognize revenue before you ship the order. If false, then the component is not required. The default value is true.
  • Title: Required to Ship
    Contains one of the following values: true or false. If true, then the component is required to be shipped. If false, then the component is not required. The default value is true.
  • Value that indicates to override the default quantity for the option class when a sales order is entered for components belonging to BOM Item Type option class. The option class quantities affect the mandatory standard components.
  • Maximum Length: 1
    Value that identifies a reference to the source transaction definition that identifies the type of transactions within each application where a budgetary control transaction is originated.
  • Title: Shippable
    Maximum Length: 1
    Value that indicates to ship an item to a customer.
  • Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
  • Value that indicates that the component is visible in the sales application. Valid values include Yes, Hide Self, and Hide Self and Descendants.
  • Title: Sales Order Basis
    Value that identifes the basis to override the default quantity for the option class when a sales order is entered, the default, for components of the BOM Item Type option class. The option class quantities affect the mandatory standard components assigned to the option class.
  • Title: Start Date
    Date and time when a component in a structure begins.
  • Title: Suggested Operation Sequence
    Read Only: true
    An attribute value that holds the suggested operation sequence.
  • Value that identifies the type of supply for components.
  • Title: To End Item Unit Number
    Maximum Length: 30
    Number that identifies the item unit or serial up to which the component is effective. It is valid only for unit or serial effective structures. Whether the value is unit or serial number depends on when the component is effective.
  • Maximum Length: 256
    Value that uniquely identifies the bill sequence of the root item of the structure.
  • Maximum Length: 256
    Value that uniquely identifies the root item for the explosion of the structure.
  • Value that identifies the root item for the explosion of the structure.
  • An attribute that determines whether option class item data should be loaded into configurator models or not.
  • Maximum Length: 255
    Value that uniquely identifes a grouping of all items of a particular category that share the same set of item attributes, used as a high-level grouping for processes. For example, each account generator item type , such as FA account generator, contains a group of processes for determining how an accounting flexfield code combination is created.
  • Title: Supply Type
    Value that identifies the type of supply for components.
  • Title: Yield
    Value that identifies the planned or actual output of a process. Values include loss, increase, or no change in the planned or actual output quantity.
Nested Schema : itemStructures-StructureAttachments-item-response
Type: object
Show Source
  • Title: Attached Document Id
    Unique identifier for a document that's an attachment in the repository.
  • Title: Category
    Maximum Length: 30
    Represents a component of a catalog used for classification of items.
  • Title: Shared
    Value that uniquely identifies whether the repository file is shared by the item structure.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    Name of the user who created the attachment associated with the item structure.
  • Title: Created By User Name
    Read Only: true
    User name of the user who created the attachment associated with the item structure.
  • Title: Creation Date
    Read Only: true
    Date on which the attachment was associated with the item structure.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Unique identifier for the data type of the attachment.
  • Title: Description
    Maximum Length: 255
    Value that represents the description of the attachment.
  • Maximum Length: 255
    Unique identifier for a document in the repository.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Value that represents the repository folder path of the attachment.
  • Maximum Length: 255
    Value that represents the version number of attachment in the repository.
  • Read Only: true
    Maximum Length: 255
    Preview URL of the attachment.
  • Read Only: true
    Value that represents the URL of the attachment.
  • Title: DownloadInfo
    Value that represents the download information of the attachment.
  • Title: Error Status Code
    Value that represents the error status associated with the attachment creation.
  • Title: Error Status Message
    Value that represents the error details associated with the attachment creation.
  • Title: Expiration Date
    Value that represents the expiration date of the attachment associated with the item structure.
  • Title: File Contents
    Contents of the file attachment.
  • Title: File Name
    Maximum Length: 2048
    Value the represents the name of a file of the attachment.
  • Title: File Url
    Value that represents the URL of the attachment file.
  • Title: Last Update Date
    Read Only: true
    Indicates the date and time of the last update of the attachment.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    Indicates the last user who updated the attachment.
  • Title: Last Updated By User
    Read Only: true
    Indicates the user name of the user who updated the attachment.
  • Links
  • Title: Title
    Value that represents the title of the attachment.
  • Title: Uploaded File Content Type
    Value that represents the content type of the file attachments associated with the item structure.
  • Title: File Size
    Value that indicates the length of the file attachment associated with the item structure.
  • Title: Uploaded File Name
    Value that indicates the name of the file attachment associated with the item structure.
  • Title: Uploaded Text
    Contents of the text file that's attached.
  • Title: Uri
    Maximum Length: 4000
    Value the represents the Uniform Resource Identifier (URI) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
  • Title: Url
    Maximum Length: 4000
    Value that represents the URL for the attachment.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Value that represents the name of user who uploads the attachment.
Nested Schema : itemStructures-StructureDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all structures.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemStructures"

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "BillSequenceId": 6924,
            "ChangeNotice": null,
            "OrganizationId": "604",
            "OrganizationCode": "P4",
            "ItemId": "1148",
            "ItemNumber": "SB21211",
            "AlternateBOMDesignator": "Primary",
            "StructureName": "Primary",
            "Description": null,
            "EffectivityControl": 1,
            "EffectivityControlValue": "Date",
            "CommonItemNumber": "SB21211",
            "CommonOrganizationCode": "P4",
            "SourceItemNumber": "SB21211",
            "SourceOrganizationCode": "P4",
            "CreationDateTime": "1998-01-24T12:43:41+00:00",
            "LastUpdateDateTime": "1998-01-24T12:43:41+00:00",
            "OriginalSystemReference": null,
            ...
        },
  ...
 ],
 ...
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get all itemStructures of one speicific item:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemStructures?q=ItemNumber=JUN26_PIM001"

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "BillSequenceId": 300100152396998,
            "ChangeNotice": null,
            "OrganizationId": "204",
            "OrganizationCode": "V1",
            "ItemId": "300100152396951",
            "ItemNumber": "JUN26_PIM001",
            "AlternateBOMDesignator": "EBOM_KM",
            "StructureName": "EBOM_KM",
            "Description": "test",
            "EffectivityControl": 1,
            "EffectivityControlValue": "Date",
            "CommonItemNumber": "JUN26_PIM001",
            "CommonOrganizationCode": "V1",
            "SourceItemNumber": "JUN26_PIM001",
            "SourceOrganizationCode": "V1",
            "CreationDateTime": "2018-06-26T02:48:27.800+00:00",
            "LastUpdateDateTime": "2018-06-26T02:49:28.539+00:00",
            "OriginalSystemReference": null,
            ...
        },
  ...
 ],
 ...
}
Back to Top