Get all affected objects
get
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject
Request
Path Parameters
-
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: Finds affected items based on the primary key.
Finder Variables:- ChangeLineId; integer; Value that uniquely identifies the change line.
- PrimaryKey: Finds affected items based on the 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:- CancelationDate; string; Date when the changes to the item was canceled.
- ChangeLineId; integer; Value that uniquely identifies the change line associated with the item in the change order. The same item can be added multiple times to a single change order and each change line will have a unique identifier.
- EffectivityOnApprovalFlag; boolean; Contains one of the following values: true or false. If true, then the change line is effective immediately. If false, then the change line is not effective immediately. The default value is false.
- ImplementationDate; string; Date when the changes to the item was implemented.
- ItemId; integer; Value that uniquely identifies the part, item, product, or service assigned to the change object.
- ItemNumber; string; Number that identifies the item.
- LifecycleStateId; integer; Value that uniquely identifies the lifecycle phase of the affected item in the change order.
- NewItemRevision; string; New revision of the affected item.
- NewRevisionReason; string; Reason for the new revision.
- ObjectVersionNumber; integer; Number that identifies the object version of the change line.
- OldRevision; string; Previous revision of the affected item.
- RevisionId; integer; Value that uniquely identifies a revision of an item in a change object.
- ScheduledDate; string; Date when the item will be effective.
- SequenceNumber; integer; Sequence number of the change line in the change order.
- StatusCodeValue; string; Abbreviation that identifies the status of the item in the change order.
- StatusTypeValue; string; Value that indicates the status of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Statuses 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
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-item-response
Type:
Show Source
object
-
AffectedItem: array
Affected Items
Title:
Affected Items
The Affected Items resource gets the items in the change order. -
AffectedItemAML: array
Affected Item AMLs
Title:
Affected Item AMLs
The Affected Item AMLs resource gets the approved manufacturers of an item in a change order. -
AffectedItemAttachment: array
Affected Item Attachments
Title:
Affected Item Attachments
The Affected Item Attachments resource gets the attachments of an affected item in the change order. -
AffectedItemStructure: array
Affected Item Structures
Title:
Affected Item Structures
The Affected Item Structures resource gets the details of the structure of the affected item. -
CancelationDate: string
(date-time)
Read Only:
true
Date when the changes to the item was canceled. -
ChangeLineDFF: array
Flexfields for Change Lines
Title:
Flexfields for Change Lines
The Flexfields for Change Lines resource gets the descriptive flexfields associated with the change line. -
ChangeLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the change line associated with the item in the change order. The same item can be added multiple times to a single change order and each change line will have a unique identifier. -
EffectivityOnApprovalFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the change line is effective immediately. If false, then the change line is not effective immediately. The default value is false. -
ImplementationDate: string
(date-time)
Read Only:
true
Date when the changes to the item was implemented. -
ItemId: integer
(int64)
Value that uniquely identifies the part, item, product, or service assigned to the change object.
-
ItemNumber: string
Maximum Length:
255
Number that identifies the item. -
LifecycleStateId: integer
(int64)
Read Only:
true
Value that uniquely identifies the lifecycle phase of the affected item in the change order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewItemRevision: string
Maximum Length:
18
New revision of the affected item. -
NewRevisionReason: string
Read Only:
true
Maximum Length:80
Reason for the new revision. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Number that identifies the object version of the change line. -
OldRevision: string
Previous revision of the affected item.
-
RevisionId: integer
(int64)
Value that uniquely identifies a revision of an item in a change object.
-
ScheduledDate: string
(date-time)
Date when the item will be effective.
-
SequenceNumber: integer
Read Only:
true
Sequence number of the change line in the change order. -
StatusCodeValue: string
Read Only:
true
Abbreviation that identifies the status of the item in the change order. -
StatusTypeValue: string
Read Only:
true
Value that indicates the status of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Statuses task.
Nested Schema : Affected Items
Type:
array
Title:
Affected Items
The Affected Items resource gets the items in the change order.
Show Source
Nested Schema : Affected Item AMLs
Type:
array
Title:
Affected Item AMLs
The Affected Item AMLs resource gets the approved manufacturers of an item in a change order.
Show Source
Nested Schema : Affected Item Attachments
Type:
array
Title:
Affected Item Attachments
The Affected Item Attachments resource gets the attachments of an affected item in the change order.
Show Source
Nested Schema : Affected Item Structures
Type:
array
Title:
Affected Item Structures
The Affected Item Structures resource gets the details of the structure of the affected item.
Show Source
Nested Schema : Flexfields for Change Lines
Type:
array
Title:
Flexfields for Change Lines
The Flexfields for Change Lines resource gets the descriptive flexfields associated with the change line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-item-response
Type:
Show Source
object
-
ACDTypeValue: string
Read Only:
true
Value that indicates if the item is added, changed, or deleted as part of the change order. -
ApprovalStatus: string
Title:
Approval Status
Maximum Length:30
Status that indicates whether or not the item is approved for use in transactions. -
ApprovalStatusValue: string
Status of the approval sought for item.
-
AssetTrackedValue: string
Value that indicates how the item is tracked as an asset. Values include Customer Asset, Not Tracked, and Full Lifecycle.
-
BuyerEmailAddress: string
Email address of the buyer associated with the item.
-
CategoryCode: string
Maximum Length:
240
Abbreviation that identifies the item class associated with the item category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task. -
ChangeLineId: integer
(int64)
Title:
Change Order Number
Default Value:-1
Value that uniquely identifies the change line of the component. -
ChangeNotice: string
Number that identifies the change order associated with the item.
-
ChangeOrderLineSequenceNumber: integer
Read Only:
true
Line number in the change order that references the affected item. The same item can be added multiple times to a change order and each line gets a separate sequence number. -
CommonSupplyProjectDemandFlag: boolean
Title:
Allow Use of Common Supplies
Maximum Length:1
Contains one of the following values: True or False. If True, then the material can be planned, picked, and issued from common inventory if sufficient inventory does not exist in the project inventory. If False, then the material cannot be planned, picked, or issued from common inventory even if sufficient inventory does not exist in the project inventory. The default value is False. For a list of attribute value interdependencies, se the Interdependent Item Attributes topic at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
CommsActivationRequiredFlag: boolean
Title:
Enable Provisioning
Maximum Length:1
Contains one of the following values: true or false. If true, then the item is eligible for electronic fulfillment by the service fulfillment manager. If false, then the item is not eligible for electronic fulfillment. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the item to the change. -
CreateSupplyAfterDate: string
(date)
Title:
Create Supply After
Date after which the supply for the item is considered while generating planned orders. -
CreationDateTime: string
(date-time)
Read Only:
true
Date and time when the item was added to the change. -
CurrentPhaseCode: string
Title:
Lifecycle Phase
Maximum Length:30
Abbreviation that identifies the lifecycle phase of the item. -
EnableIotFlag: boolean
Title:
Enable IOT
Maximum Length:1
Default Value:false
Contains one of the following values: True or False. If True, then the asset can be enabled for Internet of Things (IoT). If False, then the asset cannot be enabled for IoT. The default value is False. For a list of attribute value interdependencies, see the Interdependent Item Attributes topic at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
EnforceShipToLocationValue: string
Maximum Length:
255
Value that indicates an option to control whether the supplier can deliver to a location that differs from the ship to location defined on the purchase order. A list of accepted values is defined in the lookup type EGP_RECEIPTACTIONVS_TYPE. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is None. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
ExpenditureTypeValue: string
Type of default expenditure to be used in project driven supply chain transactions. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Expenditure Types task. The default value is Null. For a list of attribute value interdependencies, see the Interdependent Item Attributes topic at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
HardPeggingLevelValue: string
Value that identifies the type of pegging considered by the planning engine during the supply and demand netting process. A list of accepted values is defined in the lookup type ORA_EGP_HARD_PEGGING_LEVEL. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is None. For a list of attribute value interdependencies, see the Interdependent Item Attributes topic at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
ImplementationDate: string
(date-time)
Title:
Change Order Implementation Date
Date when the affected item was implemented. -
InventoryItemStatusCode: string
Title:
Item Status
Maximum Length:10
The code that uniquely identifies the item status. This attribute is reserved for internal purposes. Do not use. -
InvItemIdChar: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the item. -
IssueUOMValue: string
Unit of measure to use when issuing the item from inventory. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Units of Measures task. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
ItemClass: string
Class of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Classes task.
-
ItemDescription: string
Title:
Description
Maximum Length:240
Description of the item. -
ItemEffCategory: array
ItemEffCategory
-
ItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemNumber: string
Title:
Item
Maximum Length:300
Number that identifies the item. -
ItemRevision: array
Item Revisions
Title:
Item Revisions
The Item Revisions resource gets the revision associated with the affected item in the change order. -
ItemStatusValue: string
Value that indicates the status of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Item Statuses task.
-
ItemSupplierAssociation: array
ItemSupplierAssociation
-
ItemType: string
Title:
User Item Type
Maximum Length:30
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. -
LastUpdateDateTime: string
(date-time)
Read Only:
true
Date and time when the affected item was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the affected item in the change. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login of the user who most recently updated the item in the change. -
LifecyclePhaseValue: string
Value that indicates the lifecycle phase of an item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Abbreviation that identifies the organization of the item.
-
OrganizationId: integer
(int64)
Value that uniquely identifies the organization for the item. The value of this attribute is VersionId for a pending or update operation, such as updating the item version.
-
OrgId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization of the item. -
OrgIdChar: string
Read Only:
true
Maximum Length:255
Value that uniquely identifies the organization of the item. -
PackagingStringValue: string
Value that indicates the packaging of an item. Review and update the value for this attribute using the Item work area, and the Edit Item page.
-
PricingUOMValue: string
Value that indicates the unit of measure that is used to determine pricing for an item. A list of accepted values is defined in the lookup type EGP_ITEM_PRICING. Review the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. The default value is Primary. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
PrimaryUOMCode: string
Title:
Primary Unit of Measure
Maximum Length:3
Abbreviation that identifies the unit of measure that the item uses. -
PrimaryUOMValue: string
Unit that is primarily used to measure quantities of the item.
-
ReplenishmentSourceTypeValue: string
Value that determines how to replenish an inventory that the requests have depleted. A list of accepted values is defined in the lookup type EGP_SOURCE_TYPES. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
RequestId: integer
(int64)
Value that uniquely identifies the request.
-
RequiresFulfillmentLocationFlag: boolean
Title:
Requires Fulfillment Location
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the fulfilment location of the item is required. If false, then the fulfilment location of the item is not required. The default value is false. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169. -
SecondaryUOMValue: string
Secondary unit of measure of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Units of Measures task. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
StandardCoverageValue: string
Value that indicates the coverage template associated with the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Coverage Times task. The default value is Null. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
TrackingUOMValue: string
Unit of measure of the item. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Units of Measures task. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
-
UserItemTypeValue: string
Type of the item. A list of accepted values is defined in the lookup type EGP_ITEM_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
Nested Schema : Item Revisions
Type:
array
Title:
Item Revisions
The Item Revisions resource gets the revision associated with the affected item in the change order.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemEffCategory-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
240
-
InventoryItemId: integer
(int64)
Title:
Item
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationId: integer
-
OrganizationId: integer
(int64)
Title:
Organization
-
StyleItemFlag: boolean
Title:
Style Item
Maximum Length:1
-
StyleItemId: integer
(int64)
Title:
Style Item Number
-
TemplateItemFlag: string
Title:
Template Item
Maximum Length:1
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 : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-item-response
Type:
Show Source
object
-
AltRevisionCode: string
Maximum Length:
40
-
AttachmentEntityName: string
Maximum Length:
255
Default Value:ITEM_REVISION_ENTITY
-
ChangeLineId: integer
(int64)
-
ContextChangeLineId: integer
Default Value:
-1
-
ContextDate: string
(date-time)
-
ContextVersionId: integer
Default Value:
-1
-
CopyAttachments: boolean
-
CopyDocuments: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Who column: An attribute which indicates the user that created the item revision. -
CreationDateTime: string
(date-time)
Read Only:
true
Who column: An attribute that indicates the date and time of the creation of the item revision. -
EffectivityDate: string
(date-time)
Title:
Effective Date
Revision effectively date -
EndEffectivityDate: string
(date-time)
Read Only:
true
Date and time when the effectivity of the revision ends. -
ImplementationDate: string
(date-time)
Read Only:
true
Date and time when the revision was implemented. -
InventoryItemId: integer
(int64)
Read Only:
true
-
InvItemIdChar: string
Read Only:
true
Maximum Length:255
-
ItemId: integer
(int64)
An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
-
ItemRevisionDescription: string
Title:
Description
Maximum Length:240
The description for on item revision. -
ItemRevisionEffCategory: array
ItemRevisionEffCategory
ItemService.ItemRevisionEffCategory
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Who column: An attribute which indicates the date and time of the last update of the item revision. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Who column: An attribute which indicates the user that last updated the item revision -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: An attribute which indicates the user that logged in last for the item revision -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
This value is set to value of '1" when the item is created and incremented every time the item is updated.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
-
OrganizationId: integer
(int64)
Read Only:
true
An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting. -
OrganizationId1: integer
(int64)
-
OrgIdChar: string
Read Only:
true
Maximum Length:255
-
RequestId: integer
(int64)
This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
-
RevisionCode: string
Title:
Revision Code
Maximum Length:18
An attribute value that represents a revision. -
RevisionExtensibleFlexfieldCategoryCode: string
Maximum Length:
240
An attribute value for the EFF category code for the Item revision. -
RevisionId: integer
(int64)
An unique identifier of a revision.
-
RevisionIdChar: string
Read Only:
true
Maximum Length:255
-
RevisionReason: string
Title:
Revision Reason
Maximum Length:30
-
RevisionReasonValue: string
An attribute value that represents the reason for a revision.
-
VersionAsOfDate: string
(date-time)
-
VersionId: integer
Default Value:
-1
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response
Type:
Show Source
object
-
CategoryCode: string
Maximum Length:
240
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RevisionId: integer
(int64)
-
VersionId: integer
Default Value:
-1
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemSupplierAssociation-item-response
Type:
Show Source
object
-
AcdType: string
Maximum Length:
30
Default Value:PROD
-
Address: string
Maximum Length:
255
An attribute that represents the street address where asset party is located. -
AddressName: string
Maximum Length:
255
An attribute that represents the name of the supplier address. -
AlternateSupplierNumber: string
Maximum Length:
255
This refers to Supplier number of Supplier in procurement. -
AssociationId: integer
(int64)
An unique identifier for the item supplier association.
-
ChangeBitMap: string
Maximum Length:
10
Default Value:0
-
ChangeLineId: integer
(int64)
Default Value:
-1
-
CreationDateTime: string
(date-time)
Read Only:
true
Who column: An attribute that indicates the date and time of the creation of the item supplier. -
ImplementationDate: string
(date-time)
-
InventoryItemId: integer
(int64)
Read Only:
true
-
ItemId: integer
(int64)
An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
-
ItemSupplierEffCategory: array
ItemSupplierEffCategory
ItemService.ItemSupplierEffCategory
-
LastUpdateDateTime: string
(date-time)
Read Only:
true
Who column: An attribute which indicates the date and time of the last update of the item supplier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
This value is set to value of '1" when the item is created and incremented every time the item is updated.
-
OrganizationId: integer
(int64)
Read Only:
true
An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting. -
OrganizationId1: integer
(int64)
-
PartySiteNumber: string
An attribute value that represents the supplier site name for the supplier site association.
-
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
A flag that indicates whether the association is primary for the item. -
RegistryId: string
Read Only:
true
Maximum Length:255
Registry ID of a supplier party is a number that uniquely identifies a party. Review and update the value for this attribute using the Manage suppliers task. -
RequestId: integer
(int64)
Read Only:
true
This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID. -
Segment1: string
-
StatusCode: integer
Title:
Status Code
Default Value:1
-
SupplierExtensibleFlexfieldCategoryCode: string
Maximum Length:
240
An unique identifier for the EFF category code for the Item supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies a supplier.
-
SupplierItemNumber: string
Maximum Length:
255
This attribute is not used.Use ItemRelationshipService to obtain the supplier items. -
SupplierName: string
An attribute value for the vender that will supply the item.
-
SupplierNumber: string
Maximum Length:
255
This refers to Registry ID of Supplier party. -
SupplierSiteAssociationStatus: string
An attribute value for the status of the item supplier association.
-
SupplierSiteAssociationStatusValue: string
-
SupplierSiteId: integer
(int64)
Value that uniquely identifies a supplier address.
-
VersionEndDate: string
(date-time)
-
VersionId: integer
(int64)
-
VersionStartDate: string
(date-time)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemSupplierAssociation-ItemSupplierEffCategory-item-response
Type:
Show Source
object
-
AcdType: string
Maximum Length:
30
Default Value:PROD
-
AssociationId: integer
(int64)
-
CategoryCode: string
Maximum Length:
240
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationId: integer
(int64)
Read Only:
true
-
OrganizationId: integer
(int64)
-
SupplierId: integer
(int64)
-
SupplierSiteId: integer
(int64)
-
VersionId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemAML-item-response
Type:
Show Source
object
-
ACDTypeCode: string
Read Only:
true
Value that indicates if the manufacturer 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 item relationship. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the relationship between the item and the manufacturer part. -
CreationDate: string
(date-time)
Read Only:
true
Date when the relationship was created. -
Description: string
Read Only:
true
Maximum Length:240
Description of the relationship between item and the manufacturer part. -
EndDateActive: string
(date-time)
Read Only:
true
Date when the association between the item and the manufacturer part ends. -
ImplementationDate: string
(date-time)
Read Only:
true
Date of the relationship between an item and a manufacturer part was implemented. -
InventoryItemId: integer
Value that uniquely identifies an item.
-
ItemNumber: string
Maximum Length:
255
Number that identifies the item. -
ItemRelationshipId: integer
(int64)
Value that uniquely identifies the relationship between an item and a manufacturer part.
-
ItemRelationshipType: string
Read Only:
true
Maximum Length:30
Default Value:MFG_PART_NUM
Type of the relationship. Valid values are Manufacturer, Supplier, or Customer. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the relationship between item and a manufacturer part was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item relationship. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login of the user who most recently updated the relationship. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationId: integer
Value that uniquely identifies the master organization of the relationship.
-
ObjectVersionNumber: integer
(int32)
Read Only:
true
Value that identifies the version of the approved manufacturer. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the item. -
OrganizationId: integer
Value that uniquely identifies the organization of the relationship.
-
RedLineDescription: string
Read Only:
true
New value of the description if it was updated through a change order. -
RedLineStatusCode: string
Read Only:
true
New status if it was updated through a change order. -
StartDateActive: string
(date-time)
Read Only:
true
Date when the association between the item and the manufacturer begins. -
StatusCode: string
Title:
Status
Maximum Length:30
Status of the relationship between the item and the manufacturer part. Valid values include approved, pending and obsolete. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Product Development Lookups task. -
TradingPartnerItem: string
Read Only:
true
Maximum Length:255
Name or number of the manufacturer who manufactures the part associated with the item. -
TradingPartnerItemId: integer
Value that uniquely identifies the manufacturer part number.
-
TradingPartnerName: string
Read Only:
true
Maximum Length:255
Name of the manufacturer who manufactures the part associated with the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemAttachment-item-response
Type:
Show Source
object
-
AttachedDocumentId: integer
(int64)
Value that uniquely identifies the attached document.
-
CategoryCode: string
Title:
Category
Maximum Length:30
Abbreviation that identifies the category of the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the file attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DocumentId: integer
(int64)
Value that uniquely identifies the attachment.
-
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
FileContents: string
(byte)
Contents of the file attachment.
-
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileSize: integer
Title:
Size
Read Only:true
Size of the file in the attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the application most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Revision: string
Revision of the attachment. A revision of the attachment gets created when the user checks out and checks in an attachment.
-
Title: string
Title:
Title
Title of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedText: string
Text of the attachment.
-
Url: string
Maximum Length:
4000
URL (Uniform Resource Locator) of the attachment.
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 : 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
Nested Schema : productChangeOrders-AffectedObject-ChangeLineDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for change lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ChangeLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the change line associated with the flexible fields. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubjectInternalName: string
Maximum Length:
30
Internal name of the change line flexfield.
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 affected items.
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"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ChangeLineId": 300100158099654, "ObjectVersionNumber": 1, "SequenceNumber": 10, "NewItemRevision": "B", "ItemId": 300100158100767, "RevisionId": 300100158100768, "ScheduledDate": "2018-06-22T08:11:50+00:00", "EffectivityOnApprovalFlag": true, "OldRevision": null, "ImplementationDate": null, "CancelationDate": null, "NewRevisionReason": null, "LifecycleStateId": null, "StatusTypeValue": null, "StatusCodeValue": "Draft", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6", "name": "AffectedObject", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6", "name": "AffectedObject", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400", "name": "productChangeOrders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemAML", "name": "AffectedItemAML", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/ChangeLineDFF", "name": "ChangeLineDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemStructure", "name": "AffectedItemStructure", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItemAttachment", "name": "AffectedItemAttachment", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6/child/AffectedItem", "name": "AffectedItem", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject", "name": "AffectedObject", "kind": "collection" } ] }