Get one affected item
get
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItem/{AffectedItemUniqID}
Request
Path Parameters
-
AffectedItemUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Items resource and used to uniquely identify an instance of Affected Items. The client should not generate the hash key value. Instead, the client should query on the Affected Items collection resource in order to navigate to a specific instance of Affected Items to get the hash key.
-
AffectedObjectUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
-
ChangeId(required): integer
Value that uniquely identifies the change.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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
Links
- ItemEffCategory
-
Parameters:
- AffectedItemUniqID:
$request.path.AffectedItemUniqID
- AffectedObjectUniqID:
$request.path.AffectedObjectUniqID
- ChangeId:
$request.path.ChangeId
- AffectedItemUniqID:
- ItemRevision
-
Parameters:
- AffectedItemUniqID:
$request.path.AffectedItemUniqID
- AffectedObjectUniqID:
$request.path.AffectedObjectUniqID
- ChangeId:
$request.path.ChangeId
The Item Revisions resource gets the revision associated with the affected item in the change order. - AffectedItemUniqID:
- ItemSupplierAssociation
-
Parameters:
- AffectedItemUniqID:
$request.path.AffectedItemUniqID
- AffectedObjectUniqID:
$request.path.AffectedObjectUniqID
- ChangeId:
$request.path.ChangeId
- AffectedItemUniqID: