Get all configured item structures
get
/fscmRestApi/resources/11.13.18.05/configuredItems
Request
Query Parameters
-
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 -
finder: string
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: Finds configured items according to the unique identifier in the explosion table.
Finder Variables:- LineExplId; integer; Value that uniquely identifies the generated configured item.
- findByAttributeConfigurations: Finds configured items for a model according to a specific transactional attribute value.
Finder Variables:- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. You must provide either the model name or the model identifier and the transactional attribute.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item. You must provide either the model name or the model identifier and the transactional attribute.
- SalesStructureOnlyFlag; boolean.
- TIAttributeID; integer; Value that uniquely identifies the transactional item attribute. You must provide either the attribute name or the attribute identifier and the corresponding value that may be a timestamp, number, date, or a character.
- TIAttributeName; string; Name of the transactional item attribute. You must provide either the attribute name or the attribute identifier and the corresponding value that may be a timestamp, number, date, or a character.
- TICharAttribute; string; Character value of transactional item attribute.
- TIDateAttribute; object; Date value of the transactional item attribute.
- TINumberAttribute; integer; Numeric value of the transactional item attribute.
- TITimeStampAttribute; string; Date and time value of the transactional item attribute.
- findByComponents: Finds configured items for a model that contain the specified component.
Finder Variables:- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. You must provide either the model name or the model identifier and the component name or the component identifier.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item. You must provide either the model name or the model identifier and the component name or the component identifier.
- ComponentInventoryItemId; integer; Value that uniquely identifies the inventory item for the line item.
- ComponentInventoryItemNumber; string; Number that identifies the line item.
- ConfigItemId; integer.
- ConfigItemNumber; string.
- DateCreated; object.
- SalesStructureOnlyFlag; boolean.
- findByExcludedAttributeConfigurations: Finds configured items for a model that do not have a specific transactional attribute value. This finder is used along with a NOT operator.
Finder Variables:- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. You must provide either the model name or the model identifier and the transactional attribute.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item. You must provide either the model name or the model identifier and the transactional attribute.
- SalesStructureOnlyFlag; boolean.
- TIAttributeID; integer; Value that uniquely identifies the transactional item attribute. You must provide either the attribute name or the attribute identifier and the corresponding value that may be a timestamp, number, date, or a character.
- TIAttributeName; string; Name of the transactional item attribute. You must provide either the attribute name or the attribute identifier and the corresponding value that may be a timestamp, number, date, or a character.
- TICharAttribute; string; Character value of transactional item attribute.
- TIDateAttribute; object; Date value of the transactional item attribute.
- TINumberAttribute; integer; Numeric value of the transactional item attribute.
- TITimestampAttribute; string; Date and time value of the transactional item attribute.
- findByExpiredComponents: Finds configured items for a model that contain expired components according to the specified date. You must provide either the model name or the model identifier and the component disable date.
Finder Variables:- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. You must provide either the model name or the model identifier and the component disable date.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item.
- DateDisabled; object; Date from when the item or component can no longer be used. This is defined in the base model item structure. This attribute is mandatory.
- SalesStructureOnlyFlag; boolean.
- findByRecentConfigurations: Finds configured items for a model created in the specified number of days in the past.
Finder Variables:- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. You must provide either the model name or the model identifier and the interval.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item. You must provide either the model name or the model identifier and the interval.
- Interval; integer; Number of days since the creation of the configured item. This attribute is mandatory.
- SalesStructureOnlyFlag; boolean.
- PrimaryKey: Finds configured items according to the unique identifier in the explosion table.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- ActiveItemOnlyFlag; boolean; Value that uniquely identifies items that are currently active.
- BaseModelId; integer; Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected.
- BaseModelItemDescription; string; Description of the assemble to order (ATO) model item.
- BaseModelItemNumber; string; Name of the assemble to order (ATO) model item.
- 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.
- ConfigItemDescription; string; Description of the configured item.
- ConfigItemId; integer; Value that uniquely identifies the item being assembled.
- ConfigItemNumber; string; Number that identifies the configured item.
- ConfigItemVersion; integer; Number that uniquely identifies one-time configured item version.
- DateCreated; string; Date when the configured item was created.
- DateDisabled; string; Date from when the item or component is disabled and can no longer be used. This is defined in the base model item structure.
- EffectivityDate; string; Date from when the item or component is effective. This is defined in the base model item structure.
- HeaderId; integer; Value that uniquely identifies the related match header entry.
- 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.
- ItemClassName; string; Name of the item class of the configured item.
- ItemRevision; string; Revision of the item.
- LineExplId; integer; Value that uniquely identifies the generated configured item.
- LineId; integer; Value that uniquely identifies the match detail record entry.
- MatchEnabledFlag; boolean; Contains one of the following values: true or false. If true, then the configured item will participate in configured item matching when a sales order is created containing a configured item. If false, then the configured item will not be matched. The default value is true.
- OneTimeConfigFlag; boolean; Contains one of the following values: Y or N. If Y, then the configured item is a one-time configured item. If N, then the configured item isn't a one-time configured item. The default value is N.
- OrganizationCode; string; Abbreviation that uniquely identifies the organization for the inventory item.
- OrganizationId; integer; Value that uniquely identifies the organization for the inventory item.
- OrganizationName; string; Name of the inventory item organization.
- RevisionId; integer; Value that uniquely identifies the item revision.
- SalesStructureOnlyFlag; boolean; Contains one of the following values: true or false. If true, then show sales structure. If false, then show the complete structure. The default value is false.
- SubItemType; integer; Value that identifies the type of structure. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE. The value for the root resource is 1.
- SubItemTypeName; string; Name of the type of structure. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE. The value for the root resource is Model.
- UnitOfMeasure; string; Unit of measure in which item is sold.
- UnitQuantity; number; Quantity of the component.
- UnitUOM; string; Abbreviation that uniquely identifies the unit of measure.
- WIPSupplyType; integer; Value that identifies the type of supply that is work in progress. Values include 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 work in progress supply type of the component. Values include Assembly pull, Bulk, Operation pull, Phantom, Push, and Supplier. A list of accepted values is defined in the lookup type EGP_WIP_SUP_TYPE.
-
totalResults: boolean
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
-
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : configuredItems-item-response
Type:
Show Source
object
-
ActiveItemOnlyFlag: boolean
Value that uniquely identifies items that are currently active.
-
BaseModelId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item for the assemble to order (ATO) model from which the configured item options were selected. -
BaseModelItemDescription: string
Read Only:
true
Maximum Length:240
Description of the assemble to order (ATO) model item. -
BaseModelItemNumber: string
Read Only:
true
Maximum Length:300
Name of the assemble to order (ATO) model item. -
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. -
components: array
Components
Title:
Components
The Components resource manages the items that make up the structure of the configured item. -
ConfigItemDescription: string
Read Only:
true
Maximum Length:240
Description of the configured item. -
ConfigItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item being assembled. -
ConfigItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the configured item. -
ConfigItemVersion: integer
(int32)
Read Only:
true
Number that uniquely identifies one-time configured item version. -
DateCreated: string
(date)
Read Only:
true
Date when the configured item was created. -
DateDisabled: string
(date)
Date from when the item or component is disabled and can no longer be used. This is defined in the base model item structure.
-
EffectivityDate: string
(date)
Date from when the item or component is effective. This is defined in the base model item structure.
-
HeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the related match header entry. -
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. -
ItemClassName: string
Read Only:
true
Maximum Length:80
Name of the item class of the configured item. -
ItemRevision: string
Read Only:
true
Maximum Length:18
Revision of the item. -
LineExplId: integer
(int64)
Read Only:
true
Value that uniquely identifies the generated configured 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. -
MatchEnabledFlag: boolean
Read Only:
true
Maximum Length:5
Contains one of the following values: true or false. If true, then the configured item will participate in configured item matching when a sales order is created containing a configured item. If false, then the configured item will not be matched. The default value is true. -
OneTimeConfigFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: Y or N. If Y, then the configured item is a one-time configured item. If N, then the configured item isn't a one-time configured item. The default value is N. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that uniquely identifies the organization for the inventory item. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization for the inventory item. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory item organization. -
RevisionId: integer
Read Only:
true
Value that uniquely identifies the item revision. -
SalesStructureOnlyFlag: boolean
Contains one of the following values: true or false. If true, then show sales structure. If false, then show the complete structure. The default value is false.
-
SubItemType: integer
(int64)
Read Only:
true
Value that identifies the type of structure. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE. The value for the root resource is 1. -
SubItemTypeName: string
Read Only:
true
Maximum Length:80
Name of the type of structure. A list of accepted values is defined in the lookup type EGP_BOM_ITEM_TYPE. The value for the root resource is Model. -
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
Unit of measure in which item is sold. -
UnitQuantity: number
Read Only:
true
Quantity of the component. -
UnitUOM: string
Read Only:
true
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure. -
WIPSupplyType: integer
Read Only:
true
Value that identifies the type of supply that is work in progress. Values include 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 work in progress supply type of the component. Values include 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 : 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-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
Nested Schema : configuredItems-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
Examples
This example describes how to get all configured item structures.
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"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "ConfigItemId" : 300100111982910, "RevisionId" : null, "ConfigItemNumber" : "10000", "ConfigItemDescription" : "Stovetop ATO Model", "BaseModelId" : 100100001955792, "BaseModelItemNumber" : "STOVE_ATO_MODEL", "BaseModelItemDescription" : "Stovetop ATO Model", "InventoryItemId" : 300100111982910, "ItemRevision" : null, "InventoryItemNumber" : "10000", "InventoryItemDescription" : "Stovetop ATO Model", "ItemClassId" : 100000011369001, "ItemClassName" : "Root Item Class", "HeaderId" : 300100111982929, "LineId" : 300100111982930, "SubItemType" : 1, "SubItemTypeName" : "Model", "UnitQuantity" : 1, "UnitUOM" : "Ea", "UnitOfMeasure" : "Each", "DateCreated" : "2017-07-21", "EffectivityDate" : null, "DateDisabled" : null, "OrganizationId" : 209, "OrganizationCode" : "M2", "OrganizationName" : "Tall Manufacturing", "BillSequenceId" : 300100061374748, "WIPSupplyType" : null, "WIPSupplyTypeName" : null, "LineExplId" : 8369, "SalesStructureOnlyFlag" : "false", "transactionalAttributes" : [ ], "links" : [ { "rel" : "self", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8369", "name" : "configuredItems", "kind" : "item" }, { "rel" : "canonical", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8369", "name" : "configuredItems", "kind" : "item" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8369/child/transactionalAttributes", "name" : "transactionalAttributes", "kind" : "collection" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8369/child/components", "name" : "components", "kind" : "collection" } ] }, { "ConfigItemId" : 300100112091239, "RevisionId" : null, "ConfigItemNumber" : "10001", "ConfigItemDescription" : "Standard Custom Viking Stove ATO Model", "BaseModelId" : 100100002133780, "BaseModelItemNumber" : "VIK_STV_STD_CTM_ATO_MODEL", "BaseModelItemDescription" : "Standard Custom Viking Stove ATO Model", "InventoryItemId" : 300100112091239, "ItemRevision" : null, "InventoryItemNumber" : "10001", "InventoryItemDescription" : "Standard Custom Viking Stove ATO Model", "ItemClassId" : 100000011369001, "ItemClassName" : "Root Item Class", "HeaderId" : 300100112091258, "LineId" : 300100112091259, "SubItemType" : 1, "SubItemTypeName" : "Model", "UnitQuantity" : 1, "UnitUOM" : "Ea", "UnitOfMeasure" : "Each", "DateCreated" : "2017-07-21", "EffectivityDate" : null, "DateDisabled" : null, "OrganizationId" : 209, "OrganizationCode" : "M2", "OrganizationName" : "Tall Manufacturing", "BillSequenceId" : 300100061846451, "WIPSupplyType" : null, "WIPSupplyTypeName" : null, "LineExplId" : 8618, "SalesStructureOnlyFlag" : "false", "transactionalAttributes" : [ ], "links" : [ { "rel" : "self", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618", "name" : "configuredItems", "kind" : "item" }, { "rel" : "canonical", "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/transactionalAttributes", "name" : "transactionalAttributes", "kind" : "collection" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8618/child/components", "name" : "components", "kind" : "collection" } ] }, { "ConfigItemId" : 300100112095882, "RevisionId" : null, "ConfigItemNumber" : "10002", "ConfigItemDescription" : "zcz_m1_full_ATO", "BaseModelId" : 300100083879304, "BaseModelItemNumber" : "zcz_m1_full_ATO", "BaseModelItemDescription" : "zcz_m1_full_ATO", "InventoryItemId" : 300100112095882, "ItemRevision" : null, "InventoryItemNumber" : "10002", "InventoryItemDescription" : "zcz_m1_full_ATO", "ItemClassId" : 300100014513972, "ItemClassName" : "zCZ_QA_rootic", "HeaderId" : 300100112095977, "LineId" : 300100112095978, "SubItemType" : 1, "SubItemTypeName" : "Model", "UnitQuantity" : 1, "UnitUOM" : "Ea", "UnitOfMeasure" : "Each", "DateCreated" : "2017-07-21", "EffectivityDate" : null, "DateDisabled" : null, "OrganizationId" : 204, "OrganizationCode" : "V1", "OrganizationName" : "Vision Corporation", "BillSequenceId" : 300100084811855, "WIPSupplyType" : null, "WIPSupplyTypeName" : null, "LineExplId" : 8689, "SalesStructureOnlyFlag" : "false", "transactionalAttributes" : [ ], "links" : [ { "rel" : "self", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8689", "name" : "configuredItems", "kind" : "item" }, { "rel" : "canonical", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8689", "name" : "configuredItems", "kind" : "item" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8689/child/transactionalAttributes", "name" : "transactionalAttributes", "kind" : "collection" }, { "rel" : "child", "href" : "http://servername:port/fscmRestApi/resources/version/configuredItems/8689/child/components", "name" : "components", "kind" : "collection" } ] }] }