Get all structures
get
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItemStructure
Request
Path Parameters
-
AffectedObjectUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
-
ChangeId(required): integer
Value that uniquely identifies the change.
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:- BillSequenceId
- UniqueBOM
Finder Variables:- AlternateBomDesignator
- 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:- AlternateBomDesignator; string; Alternate designator for the affected item structure.
- BillSequenceId; integer; Value that uniquely identifies the structure associated with the item.
- ChangeId; integer; Value that uniquely identifies the change order.
- CommonBillSequenceId; integer; Value that uniquely identifies the common structure of the item.
- CommonOrganizationCode; string; Abbreviation that identifies the organization of the item.
- CreationDate; string; Date when the structure of the affected item is created.
- EffectivityControl; integer; Value that indicates the way effectivity is controlled within a structure. Values include Date, Unit Number, or Serial Number.
- LastUpdateDate; string; Date when the structure in the affected item was most recently updated.
- OriginalSystemReference; string; Authoring application that is responsible for managing the record. If empty, the record is typically managed by the user interactively in the standard user interface.
- SourceBillSequenceId; integer; Value that uniquely identifies the structure from where this structure was created.
- StructureTypeId; integer; Value that uniquely identifies the structure associated with the item. Valid values include primary, alternate1, alternate2, and others. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task.
-
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 : productChangeOrders-AffectedObject-AffectedItemStructure
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 : productChangeOrders-AffectedObject-AffectedItemStructure-item-response
Type:
Show Source
object
-
AlternateBomDesignator: string
Title:
Name
Maximum Length:80
Alternate designator for the affected item structure. -
BillSequenceId: integer
Value that uniquely identifies the structure associated with the item.
-
BomItemType: number
Title:
Structure Item Type
Value used to control the functionality of the bill of material. Values include Model, Option Class, Planning, Product Family, and Standard. -
ChangeId: integer
Value that uniquely identifies the change order.
-
ChangeNotice: string
Number that uniquely identifies the change object.
-
CommonBillSequenceId: integer
Value that uniquely identifies the common structure of the item.
-
CommonOrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the item. -
CommonOrganizationId: integer
Value that uniquely identifies the organization associated with the common structure of the item.
-
CreationDate: string
(date-time)
Read Only:
true
Date when the structure of the affected item is created. -
EffectivityControl: integer
Title:
Effectivity Control
Value that indicates the way effectivity is controlled within a structure. Values include Date, Unit Number, or Serial Number. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the structure in the affected item was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemReference: string
Maximum Length:
50
Authoring application that is responsible for managing the record. If empty, the record is typically managed by the user interactively in the standard user interface. -
SourceBillSequenceId: integer
Value that uniquely identifies the structure from where this structure was created.
-
StructureComponent: array
Structure Components
Title:
Structure Components
The Structure Components resource gets the components in a structure of an affected item. -
StructureTypeId: integer
Value that uniquely identifies the structure associated with the item. Valid values include primary, alternate1, alternate2, and others. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Structure Type Details task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Structure Components
Type:
array
Title:
Structure Components
The Structure Components resource gets the components in a structure of an affected item.
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 : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-item-response
Type:
Show Source
object
-
ACDTypeCode: integer
Title:
Change Action
Default Value:1
Value that indicates whether the component is being added, changed, or deleted through a change line. -
AlternateBOMDesignator: string
Maximum Length:
255
Value that identifies the alternate bill of material (BOM) designator of the item. -
BillSequenceId: integer
Value that uniquely identifies the structure associated with the item.
-
ChangeId: integer
Value that uniquely identifies the change order associated with the component.
-
ChangeLineId: integer
Default Value:
-1
Value that uniquely identifies the change line associated with the component. -
ChangeNotice: string
Maximum Length:
255
Number that identifies the change order associated with the item. -
ComponentItemClass: string
Read Only:
true
Maximum Length:255
Class of the component item. This attribute is read-only and is not required for an update operation. -
ComponentItemId: string
Maximum Length:
240
Value that uniquely identifies the item associated with the component. -
ComponentQuantity: number
Title:
Quantity
Default Value:1
Quantity of the component that is used to build the structure. -
ComponentRemarks: string
Title:
Comments
Maximum Length:240
Comments entered by the user for the component. -
ComponentSequenceId: integer
Value that uniquely identifies the component that is currently in the structure.
-
ComponentYieldFactor: number
Title:
Yield
Default Value:1
Planned or actual output of a process, relevant to the quantity. The yield includes a loss, an increase, or no change in the planned or actual output quantity. -
CreationDate: string
(date-time)
Read Only:
true
Date when the application created the component. -
DisableDate: string
(date-time)
Title:
Effective End Date
Date when the component was disabled. -
EffectivityDate: string
(date-time)
Title:
Effective Start Date
Date when the component became effective to be used in the structure. -
ImplementationDate: string
(date-time)
Title:
Effective Date
Date when the component was implemented. -
ItemNum: number
Title:
Item Sequence
Number that identifies the item associated with the component. -
ItemNumber: string
Number that identifies the item corresponding to the component.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the application most recently updated the component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number that identifies the version of the object of the component. -
OldComponentSequenceId: integer
Value that uniquely identifies the component that was originally present in the structure.
-
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the item. -
OrganizationId: string
Maximum Length:
240
Value that uniquely identifies the organization of the component. -
OriginalSystemReference: string
Maximum Length:
50
Value that identifies the record from the original application. -
PrimaryUomCode: string
Title:
Component UOM
Maximum Length:30
Value that indicates the unit of measure of the component as used in a bill of materials. -
QuantityRelatedFlag: boolean
Title:
Quantity Related
Default Value:true
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. -
RedlinedReferenceDesignator: array
Reference Designators
Title:
Reference Designators
The Reference Designators resource manages the details of a reference designator. -
RedlinedSubstituteComponent: array
Substitute Components
Title:
Substitute Components
The Substitute Components resource manages the details of a substitute component.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedReferenceDesignator-item-response
Type:
Show Source
object
-
ACDType: integer
Read Only:
true
Value that indicates if the reference designator is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Value that indicates if the reference designator is being added, modified, or deleted through a change line. -
ChangeLineId: integer
(int64)
Read Only:
true
Default Value:-1
Value that uniquely identifies the change line corresponding to the reference designator. -
ChangeNotice: string
Read Only:
true
Value that uniquely identifies the change order associated with the reference designator. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the reference designator was created. -
Description: string
Description for the reference designator.
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the reference designator was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceDesignator: string
Name of the reference designator.
-
ReferenceDesignatorDFF: array
Flexfields for Reference Designators
Title:
Flexfields for Reference Designators
The Flexfields for Reference Designators resource gets the descriptive flexfields associated with the reference designator. -
ReferenceDesignatorSequenceId: integer
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedReferenceDesignator-ReferenceDesignatorDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the structure. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RefDesigSequenceId: integer
(int64)
Value that uniquely identifies the reference designator. This attribute is read-only and is not required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-item-response
Type:
Show Source
object
-
ACDType: integer
Read Only:
true
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ChangeNotice: string
Title:
Change Notice
Read Only:true
Value that uniquely identifies the change order associated with the substitute component. -
CreationDate: string
(date-time)
Read Only:
true
Date when the substitute component was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the substitute component was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Quantity: number
Quantity of the substitute component that is used to build the structure.
-
SequenceId: integer
Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.
-
SubstituteComponentDFF: array
Flexfields for Substitute Components
Title:
Flexfields for Substitute Components
The Flexfields for Substitute Components resource gets the descriptive flexfields associated with the substitute component. -
SubstituteComponentId: integer
Value that uniquely identifies the item of the substitute component.
-
SubstituteComponentItemNumber: string
Number that identifies the item of the substitute component.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-SubstituteComponentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context that references the substitute component. -
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubCompSequenceId: integer
(int64)
Value that uniquely identifies the substitute component in a structure. This attribute is read-only and is not required for an update operation.
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 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/productChangeOrders/ChangeId/child/AffectedObject/ChangeLineId/child/AffectedItemStructure"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "StructureTypeId": 1, "AlternateBomDesignator": "Primary", "BillSequenceId": 300100158100772, "LastUpdateDate": "2018-06-22T07:51:31.129+00:00", "CreationDate": "2018-06-22T07:51:30.823+00:00", "CommonBillSequenceId": 300100158100772, "CommonOrganizationId": null, "OriginalSystemReference": null, "EffectivityControl": 1, "SourceBillSequenceId": 300100158100772, "ChangeId": null, "ChangeNotice": null, "BomItemType": 4, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemStructure/300100158100772", "name": "AffectedItemStructure", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemStructure/300100158100772", "name": "AffectedItemStructure", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6", "name": "AffectedObject", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemStructure/300100158100772/child/StructureComponent", "name": "StructureComponent", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemStructure", "name": "AffectedItemStructure", "kind": "collection" } ] }