Get all items that use this component
get
/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/WhereUsed
Request
Path Parameters
-
BillSequenceId(required): integer
Value that uniquely identifies the structure. This attribute is read-only, which can be modified only if the resource is already modified.
-
ComponentSequenceId(required): number
Value that uniquely identifies the component in a structure. This attribute is read-only and is not required for an update operation.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
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
Finder Variables:
- PrimaryKey
-
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:- BasisValue; string; Value that indicates how the component quantity is consumed in an assembly. Values include item and lot.
- ComponentBillSequenceId; integer; Value that uniquely identifies the parent structure.
- ComponentItemDescription; string; Description of the item of a component.
- ComponentItemNumber; string; Number that indicates the item of a component.
- ComponentPath; string; Value that represents the hierarchical path of a component item to the root item in a structure.
- ComponentSequenceId; integer; Value that uniquely identifies the component in a structure.
- EffectivityControlValue; string; Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
- EndDateTime; string; Date and time when a component in a structure ends.
- FromSerialNumber; string; Number that indicates the item serial from which the component is effective in a structure. It is valid only for serial effective structures.
- FromUnitNumber; string; Number that indicates the item unit or serial from which the component is effective. It is valid only for unit effective structures.
- ItemClassName; string; Name in metadata that is common to all items that share the category.
- ItemStatusValue; string; 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.
- ItemTypeValue; string; 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.
- 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.
- ParentBillSequenceId; integer; Value that uniquely identifies the parent structure.
- ParentItemNumber; string; Number that uniquely identifies the parent identifier for a part, material, product, or service.
- Quantity; number; Quantity of a component in a structure.
- StartDateTime; string; Date and time when a component in a structure begins.
- StructureName; string; Name of the structure. This attribute is read-only, which can be modified for the create operation.
- ToSerialNumber; string; Number that identifies the item serial up to which the component is effective in a structure.
- ToUnitNumber; string; Number that identifies the item unit up to which the component is effective.
- TopItemFlag; boolean; 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.
-
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(required):
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(required):
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 : itemStructures-Component-WhereUsed
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 : itemStructures-Component-WhereUsed-item-response
Type:
Show Source
object
-
BasisValue: string
Maximum Length:
80
Value that indicates how the component quantity is consumed in an assembly. Values include item and lot. -
ComponentBillSequenceId: integer
(int64)
Value that uniquely identifies the parent structure.
-
ComponentItemDescription: string
Maximum Length:
240
Description of the item of a component. -
ComponentItemNumber: string
Maximum Length:
300
Number that indicates the item of a component. -
ComponentPath: string
Maximum Length:
4000
Value that represents the hierarchical path of a component item to the root item in a structure. -
ComponentSequenceId: integer
(int64)
Value that uniquely identifies the component in a structure.
-
EffectivityControlValue: string
Value that indicates the method used to control effectivity in a structure. Values include Date, Unit Number, or Serial Number.
-
EndDateTime: string
(date-time)
Date and time when a component in a structure ends.
-
FromSerialNumber: string
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. -
FromUnitNumber: string
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. -
ItemClassName: string
Maximum Length:
250
Name in metadata that is common to all items that share the category. -
ItemStatusValue: string
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. -
ItemTypeValue: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
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.
-
ParentBillSequenceId: integer
(int64)
Value that uniquely identifies the parent structure.
-
ParentItemNumber: string
Number that uniquely identifies the parent identifier for a part, material, product, or service.
-
Quantity: number
Quantity of a component in a structure.
-
StartDateTime: string
(date-time)
Date and time when a component in a structure begins.
-
StructureName: string
Name of the structure. This attribute is read-only, which can be modified for the create operation.
-
TopItemFlag: boolean
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. -
ToSerialNumber: string
Maximum Length:
30
Number that identifies the item serial up to which the component is effective in a structure. -
ToUnitNumber: string
Maximum Length:
30
Number that identifies the item unit up to which the component is effective.
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.
Examples
This example describes how to get all items that use this component.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/itemStructures/BillSequenceId/child/Component/ComponentSequenceId/child/WhereUsed"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "OrganizationCode": "V1", "ParentItemNumber": null, "StructureName": "EBOM_KM", "ParentBillSequenceId": null, "TopItemFlag": true, "EffectivityControlValue": "Date", "ComponentPath": ">JUN26_PIM001", "ComponentItemNumber": "JUN26_PIM001", "ComponentItemDescription": "JUN26_PIM001", "ComponentBillSequenceId": 300100159234307, "ComponentSequenceId": -1, "Quantity": null, "ItemClassName": "Root Item Class", "ItemTypeValue": "Finished Good", "ItemStatusValue": "Active", "BasisValue": null, "FromSerialNumber": null, "ToSerialNumber": null, "FromUnitNumber": null, "ToUnitNumber": null, "StartDateTime": null, "EndDateTime": null, ... }, ... ], ... }