Get multiple Affected Object change order
get
/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAffectedObject
Request
Path Parameters
-
productChangeOrdersV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Change Orders Version 2 resource and used to uniquely identify an instance of Product Change Orders Version 2. The client should not generate the hash key value. Instead, the client should query on the Product Change Orders Version 2 collection resource in order to navigate to a specific instance of Product Change Orders Version 2 to get the hash key.
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 Finds change order affected object by primary key
Finder Variables- ChangeLineId; integer; Find change order affected object by change line ID.
- PrimaryKey Finds change order affected object by primary key
-
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:- CancelationDateTime; string; The cancellation date of the change line.
- ChangeLineId; integer; Value that uniquely identifies the change line associated with the component.
- EffectivityOnApprovalFlag; boolean; Contains one of the following values: true or false. If true, then the change line is effective on approval. If false, then the change line isn't effective on approval. The default value is false.
- ImplementationDateTime; string; Date and time when this change order affected item was implemented.
- ItemId; integer; The affected object item ID.
- ItemNumber; string; Number that identifies the item corresponding to the component.
- NewItemRevision; string; The new revision of the item added to the change line.
- NewRevisionReason; string; The reason for the new revision of the change line.
- OldRevision; string; The previous revision of the item added to the change line.
- OldRevisionId; integer; The revision ID of the item added to the change line.
- ScheduledDateTime; string; The scheduled date of the change line.
- SequenceNumber; integer; The sequence number of the affected item.
- StatusCodeValue; string; Abbreviation that identifies the status of the change object. Valid values are open, interim approval, approval, scheduled, and completed.
- StatusTypeValue; string; Value of the status type of the change object. Valid values are open, interim approval, approval, scheduled, and completed.
-
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 : productChangeOrdersV2-changeOrderAffectedObject
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 : productChangeOrdersV2-changeOrderAffectedObject-item-response
Type:
Show Source
object
-
CancelationDateTime: string
(date-time)
Read Only:
true
The cancellation date of the change line. -
ChangeLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the change line associated with the component. -
changeOrderAffectedItem: array
Change Order Affected Items
Title:
Change Order Affected Items
The Affected Items resource gets the items in the change order. -
changeOrderAffectedItemAML: array
Change Order Affected Item Approved Manufacturers Lists
Title:
Change Order Affected Item Approved Manufacturers Lists
The Affected Item AML resource gets the approved manufacturers of an item in a change order. -
changeOrderAffectedItemAttachment: array
Change Order Affected Item Attachments
Title:
Change Order Affected Item Attachments
The Affected Item Attachments resource gets the attachments of an affected item in the change order. -
changeOrderAffectedItemStructure: array
Change Order Affected Item Structures
Title:
Change Order Affected Item Structures
The Affected Item Structures resource gets the details of the structure of the affected item. -
changeOrderAffectedObjectDFF: array
changeOrderAffectedObjectDFF
-
EffectivityOnApprovalFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the change line is effective on approval. If false, then the change line isn't effective on approval. The default value is false. -
ImplementationDateTime: string
(date-time)
Read Only:
true
Date and time when this change order affected item was implemented. -
ItemId: integer
(int64)
The affected object item ID.
-
ItemNumber: string
Maximum Length:
255
Number that identifies the item corresponding to the component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewItemRevision: string
Maximum Length:
18
The new revision of the item added to the change line. -
NewRevisionReason: string
Read Only:
true
Maximum Length:80
The reason for the new revision of the change line. -
OldRevision: string
The previous revision of the item added to the change line.
-
OldRevisionId: integer
(int64)
The revision ID of the item added to the change line.
-
ScheduledDateTime: string
(date-time)
The scheduled date of the change line.
-
SequenceNumber: integer
Read Only:
true
The sequence number of the affected item. -
StatusCodeValue: string
Read Only:
true
Abbreviation that identifies the status of the change object. Valid values are open, interim approval, approval, scheduled, and completed. -
StatusTypeValue: string
Read Only:
true
Value of the status type of the change object. Valid values are open, interim approval, approval, scheduled, and completed.
Nested Schema : Change Order Affected Items
Type:
array
Title:
Change Order Affected Items
The Affected Items resource gets the items in the change order.
Show Source
Nested Schema : Change Order Affected Item Approved Manufacturers Lists
Type:
array
Title:
Change Order Affected Item Approved Manufacturers Lists
The Affected Item AML resource gets the approved manufacturers of an item in a change order.
Show Source
Nested Schema : Change Order Affected Item Attachments
Type:
array
Title:
Change Order Affected Item Attachments
The Affected Item Attachments resource gets the attachments of an affected item in the change order.
Show Source
Nested Schema : Change Order Affected Item Structures
Type:
array
Title:
Change Order Affected Item Structures
The Affected Item Structures resource gets the details of the structure of the affected item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItem-item-response
Type:
Show Source
object
-
ACDTypeCode: string
Read Only:
true
Maximum Length:255
Value that indicates if the substitute component is being added, modified, or deleted through a change line. -
ApprovalStatus: string
Title:
Approval Status
Maximum Length:30
The approval status of the affected item in the change order. -
ApprovalStatusValue: string
Value that indicates the approval status of the change object. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task.
-
AssetTrackedValue: string
The Asset tracked value of the change order affected item
-
BuyerEmailAddress: string
Read Only:
true
The Buyer email address value of the change order affected item -
CategoryCode: string
Maximum Length:
240
The category code value of the change order affected item -
ChangeLineId: integer
(int64)
Title:
Change Order Number
Read Only:true
Default Value:-1
Value that uniquely identifies the change line associated with the component. -
CommonSupplyProjectDemandFlag: boolean
Title:
Allow Use of Common Supplies
Maximum Length:1
The common supply project demand check box value of the change order affected item. -
CommsActivationRequiredFlag: boolean
Title:
Enable Provisioning
Maximum Length:1
The COMMS activation required check box value of the change order affected item. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the change object. -
CreateFixedAssetValue: string
Value that indicates the create fixed asset for the change order affected item.
-
CreateSupplyAfterDate: string
(date)
Title:
Create Supply After
Create supply after date attribute of an affected item -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the reference designator was created. -
CurrentPhaseCode: string
Title:
Lifecycle Phase
Maximum Length:30
The Current phase code value of the change order affected item -
DefaultRepairTransactionName: string
Value that indicates the name of the system, component, and position where an asset item is used to maintain another asset.
-
EligibilityRuleFlag: boolean
Title:
Eligibility Rule
Value that indicates the eligibility rule for the change order affected item. -
EnableIotFlag: boolean
Title:
Enable IOT
Maximum Length:1
Default Value:false
The enable check box value of the change order affected item. -
EnforceShipToLocationValue: string
Maximum Length:
255
The Enforce ship to location value of the change order affected item -
ExpenditureTypeValue: string
The Expenditure type value of the change order affected item
-
ForcePurchaseLeadTimeFlag: boolean
Title:
Enforce Purchasing Lead Time
Default Value:true
Value that indicates the force purchase lead time for the change order affected item. -
HardPeggingLevelValue: string
The Hard pegging value of the change order affected item
-
ImplementationDateTime: string
(date-time)
Read Only:
true
Date when the affected item on a change order was implemented. -
InventoryItemStatusCode: string
Title:
Item Status
Maximum Length:10
Inventory Item Status Code of a change affected item. -
IssueUOMValue: string
The Issue UOM value of the change order affected item
-
ItemClass: string
The Item class value of the change order affected item
-
ItemDescription: string
Title:
Description
Maximum Length:240
The Item description value of the change order affected item -
ItemEffCategory: array
ItemEffCategory
-
ItemId: integer
(int64)
The item identifier value of the change order affected item.
-
ItemNumber: string
Title:
Item
Maximum Length:300
Number that identifies the item corresponding to the component. -
ItemStatusValue: string
The Item status value of the change order affected item
-
ItemType: string
Title:
User Item Type
Maximum Length:30
The Item type value of the change order affected item -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the reference designator was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the change object. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the affected item in the change order . -
LifecyclePhaseValue: string
The Lifecycle phase value of the change order affected item
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PackagingStringValue: string
The Packaging String value of the change order affected item
-
PricingUOMValue: string
The Pricing UOM value of the change order affected item
-
PrimaryUOMCode: string
Title:
Primary Unit of Measure
Maximum Length:3
Value that indicates the unit of measure of the component as used in a bill of materials. -
PrimaryUOMValue: string
The Primary UOM value of the change order affected item
-
QuantityReceivedTolerancePercentage: number
Title:
Tolerance Percentage
Value that indicates the tolerance percentage of the quantity received for the change order affected item. -
ReplacementTypeValue: string
Value that indicates the replacement type for the change order affected item.
-
ReplenishmentSourceTypeValue: string
The Replenishment Source Type value of the change order affected item.
-
RequiresFulfillmentLocationFlag: boolean
Title:
Requires Fulfillment Location
Maximum Length:1
Default Value:false
The check box value of the requires fulfillment location of the change order affected item. -
SalesProductTypeValue: string
Value that indicates the sales product type for the change order affected item.
-
SecondaryUOMValue: string
The secondary UOM value of the change order affected item
-
StandardCoverageValue: string
The standard coverage value of the change order affected item.
-
TrackingUOMValue: string
The Tracking UOM value of the change order affected item
-
UnderCompletionToleranceTypeValue: string
Value that indicates the undercompletion type of tolerance for the affected item in the change order.
-
UnderCompletionToleranceValue: number
Title:
Tolerance Value
Value that indicates the undercompletion tolerance of the affected item in the change order. -
UserItemTypeValue: string
User Item Type value for change order affected item.
Nested Schema : ItemEffCategory
Type:
Show Source
array
-
Array of:
object Discriminator: CategoryCode
Discriminator:
{ "propertyName":"CategoryCode", "mapping":{ "ROOT_ICC":"#/components/schemas/oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_item_categories_view_j__ItemRootIccPrivateVO-item-response" } }
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: CategoryCode
Type:
object
Discriminator: CategoryCode
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_scm_productCatalogManagement_advancedItems_flex_egoItemEff_item_categories_view_j__ItemRootIccPrivateVO-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
240
Default Value:ROOT_ICC
Value that uniquely identifies the item class with which the item revision extensible flexfield is associated. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task. -
InventoryItemId: integer
(int64)
Title:
Item
Value that uniquely identifies the part, item, product, or service. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationId: integer
Master Organization Identifier. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
OrganizationId: integer
(int64)
Title:
Organization
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
StyleItemFlag: boolean
Title:
Style Item
Maximum Length:1
Contains one of the following values: true or false. If true, then the item is a style item. If false, then the item is not a style item. The default value is false. -
StyleItemId: integer
(int64)
Title:
Style Item Number
Value that uniquely identifies the corresponding style item. -
TemplateItemFlag: string
Title:
Template Item
Maximum Length:1
This attribute is not currently used.
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 : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemAML-item-response
Type:
Show Source
object
-
ACDTypeCode: string
Read Only:
true
Value that indicates whether the component is being added, changed, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Maximum Length:255
Value that indicates whether the component is being added, changed, or deleted through a change line. -
ActiveEndDateTime: string
(date-time)
Read Only:
true
The end date of an active AML. -
ActiveStartDateTime: string
(date-time)
Read Only:
true
The start date of an affected item AML. -
ChangeLineId: integer
(int64)
Read Only:
true
Default Value:-1
Value that uniquely identifies the change line associated with the component. -
changeOrderAffectedItemAMLDFF: array
changeOrderAffectedItemAMLDFF
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the change object. -
CreationDateTime: string
(date-time)
Read Only:
true
Date when the change object was created. -
Description: string
Read Only:
true
Maximum Length:240
Description of the change object. -
ImplementationDateTime: string
(date-time)
Read Only:
true
Date when this affected item AML in the change order was implemented. -
InventoryItemId: integer
The inventory affected item ID of an affected item AML.
-
ItemNumber: string
Maximum Length:
255
Number that identifies the item corresponding to the component. -
ItemRelationshipId: integer
(int64)
Read Only:
true
The item relationship ID of an affected item AML. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when the change object was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the change object. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the affected item AML in the change order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the change object. -
OrganizationId: integer
Read Only:
true
Value that uniquely identifies the organization of the change object. -
StatusCode: string
Title:
Status
Maximum Length:30
Abbreviation that identifies the status of the change object. -
StatusCodeValue: string
Maximum Length:
255
Status code value of the change object -
TradingPartnerItem: string
Read Only:
true
Maximum Length:255
The trading partner item number of an affected item AML. -
TradingPartnerItemId: integer
The trading partner item ID of an affected item AML.
-
TradingPartnerName: string
Read Only:
true
Maximum Length:255
The trading partner name of an affected item AML.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemAML-changeOrderAffectedItemAMLDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context
-
ItemRelationshipId: integer
(int64)
-
ItemRelationshipType: string
Title:
Type
Maximum Length:30
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemAttachment-item-response
Type:
Show Source
object
-
CategoryCode: string
Title:
Category
Maximum Length:30
The category code of the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The type of attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment -
DmDocumentId: string
Maximum Length:
255
The UCM document ID of the file type attachment. -
DmVersionNumber: string
Maximum Length:
255
The UCM version number of the file type attachment. -
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the file attached -
UploadedText: string
The uploaded file text of an attachment
-
Url: string
Maximum Length:
4000
The URL of the URL type attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-item-response
Type:
Show Source
object
-
affectedItemStructureComponent: array
Change Order Affected Item Structure Components
Title:
Change Order Affected Item Structure Components
The Structure Components resource gets the components in a structure of an affected item. -
AlternateBomDesignator: string
Title:
Name
Maximum Length:80
Value that identifies the alternate bill of material designator of the item. -
BillSequenceId: integer
Value that uniquely identifies the structure associated with the item.
-
ChangeId: integer
Value that uniquely identifies the change.
-
CommonBillSequenceId: integer
The common bill sequence ID of the item structure.
-
CommonOrganizationCode: string
Maximum Length:
255
The common organization code of the item structure -
CommonOrganizationId: integer
The common organization ID of the item structure.
-
CreationDateTime: string
(date-time)
Read Only:
true
Date when the change object was created. -
EffectivityControl: integer
Title:
Effectivity Control
The effectivity control of the item structure -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when the change object was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceBillSequenceId: integer
The source bill sequence ID of the item structure.
Nested Schema : Change Order Affected Item Structure Components
Type:
array
Title:
Change Order Affected Item Structure Components
The Structure Components resource gets the components in a structure of an affected item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-item-response
Type:
Show Source
object
-
ACDTypeCode: integer
Title:
Change Action
Read Only:true
Default Value:1
Abbreviation that indicates whether the component is being added, changed, or deleted through a change line. -
affectedItemReferenceDesignator: array
Change Order Affected Item Reference Designators
Title:
Change Order Affected Item Reference Designators
The Reference Designators resource manages the details of a reference designator. -
affectedItemSubstituteComponent: array
Change Order Affected Item Substitute Components
Title:
Change Order Affected Item Substitute Components
The Substitute Components resource manages the details of a substitute component. -
AlternateBOMDesignator: string
Read Only:
true
Maximum Length:255
Value that identifies the alternate bill of material designator of the item. -
BillSequenceId: integer
Read Only:
true
Value that uniquely identifies the structure associated with the item. -
ChangeId: integer
Value that uniquely identifies the change affected item structure component
-
ChangeLineId: integer
Default Value:
-1
Value that uniquely identifies the change line associated with the affected item structure component. -
ChangeNotice: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the change object. -
ComponentItemClass: string
Read Only:
true
Maximum Length:255
Class of the component item. This attribute is read-only and isn't required for an update operation. -
ComponentItemId: string
Maximum Length:
240
Value that uniquely identifies the item associated with the component. -
ComponentItemNumber: string
The component item number of the structure component
-
ComponentQuantity: number
Title:
Quantity
Default Value:1
Quantity value of the component that's used to build the structure. -
ComponentRemarks: string
Title:
Comments
Maximum Length:240
Comments entered by the user for the affected item structure component. -
ComponentSequenceId: integer
Read Only:
true
Value that uniquely identifies the component that's currently in the affected item structure component -
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 of affected item structure component -
CreationDateTime: string
(date-time)
Read Only:
true
Date when the affected item structure component was added to the change object. -
DisableDateTime: string
(date-time)
Date when the component was disabled or redline component
-
EffectivityDateTime: string
(date-time)
Date when the affected item structure component became effective to be used in the structure.
-
FindNumber: integer
Title:
Find Number
Default Value:1
Finds the Find Number of the component in the item structure. -
ImplementationDateTime: string
(date-time)
Read Only:
true
Date when the affected item structure component was implemented via change order -
ItemSequenceNumber: number
The component item sequence number of the structure component
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when affected item structure component was last updated -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OldComponentSequenceId: integer
Read Only:
true
Replaced component sequence ID in the affected item structure -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the change object. -
OrganizationId: string
Maximum Length:
240
Value that uniquely identifies the organization of the change object. -
PrimaryUomCode: string
Title:
Component UOM
Maximum Length:30
Value that indicates the unit of measure of the affected item structure component as used in a bill of materials. -
PrimaryUOMValue: string
Maximum Length:
255
Primary UOM value of a structure component -
QuantityRelatedFlag: boolean
Title:
Quantity Related
Default Value:true
Quantity of the redline substitute component -
ReplacedBy: string
Maximum Length:
255
Value that identifies the name of the item that replaced another item. -
ReplacedByFindNumber: integer
Finds the Find Number of the replaced component in the item structure.
-
Replaces: string
Read Only:
true
Maximum Length:255
Value that identifies the name of the item that was replaced by another item. -
SuggestedOperationSequence: integer
Title:
Suggested Operation Sequence
Suggested operation sequence of the component in the item structure. -
UsePlaceholderFlag: boolean
Title:
Use Placeholder
Value that identifies if an option class holds a large set of options. The values are true or false. The default value is Null.
Nested Schema : Change Order Affected Item Reference Designators
Type:
array
Title:
Change Order Affected Item Reference Designators
The Reference Designators resource manages the details of a reference designator.
Show Source
Nested Schema : Change Order Affected Item Substitute Components
Type:
array
Title:
Change Order Affected Item Substitute Components
The Substitute Components resource manages the details of a substitute component.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-item-response
Type:
Show Source
object
-
ACDType: integer
Read Only:
true
Value that indicates if the affected object structure component redline reference designator is being added, modified, or deleted through a change line. -
ACDTypeValue: string
Read Only:
true
Value that indicates if the affected object structure component is being added, modified, or deleted through a change line. -
affectedItemReferenceDesignatorDFF: array
affectedItemReferenceDesignatorDFF
-
ChangeLineId: integer
(int64)
Read Only:
true
Default Value:-1
Value that uniquely identifies the change line associated with the affected object structure component. -
ChangeNotice: string
Read Only:
true
Value that uniquely identifies the change notice for an affected object structure component reference designator -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the affected object structure component reference designator was created. -
Description: string
Description of the affected object structure component redline reference designator designator
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the affected object structure component reference designator was most recently updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceDesignator: string
The redlined value for the affected object structure component reference designator.
-
ReferenceDesignatorSequenceId: integer
Read Only:
true
Value that uniquely identifies the redline reference designator. This attribute is read-only and isn't required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemReferenceDesignator-affectedItemReferenceDesignatorDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RefDesigSequenceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-item-response
Type:
Show Source
object
-
ACDType: integer
Read Only:
true
Value that indicates the type of redline on a substitute component to determine whether the component is being added, modified, or deleted. -
ACDTypeValue: string
Read Only:
true
Value that indicates if the substitute component is being added, modified, or deleted through a change order object -
affectedItemSubstituteComponentDFF: array
affectedItemSubstituteComponentDFF
-
CreationDateTime: string
(date-time)
Read Only:
true
Date when redline was made to the redlined substitute component was made -
EnforceIntegerRequirementsValue: string
Maximum Length:
255
Generates the demand with quantity specified in integers. It's used in supply chain planning. The values are Round Up, Round Down, or None. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date when redline was made to the redline substitute component was updated -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryUOMValue: string
Read Only:
true
Maximum Length:255
Value that indicates the unit of measure of the affected item structure's substitute component. -
Priority: integer
Value that determines the priority of the substitute component.
-
Quantity: number
Quantity of the redline substitute component
-
SubstituteComponentId: integer
Value that uniquely identifies the item of the redlined substitute component on change order
-
SubstituteComponentItemNumber: string
Number that identifies the item of the redlined substitute component.
-
SubstituteComponentSequenceId: integer
Value that uniquely identifies the redlined substitute component in a structure. This attribute is read-only and isn't required for an update operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedItemStructure-affectedItemStructureComponent-affectedItemSubstituteComponent-affectedItemSubstituteComponentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubCompSequenceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAffectedObject-changeOrderAffectedObjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ChangeLineId: integer
(int64)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubjectInternalName: string
Maximum Length:
30
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source