1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Product Change Orders (Deprecated)
  5. Affected Objects

Get one affected object

get

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}

Request

Path Parameters
  • 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.
  • Value that uniquely identifies the change.
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : productChangeOrders-AffectedObject-item-response
Type: object
Show Source
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 : productChangeOrders-AffectedObject-AffectedItem-item-response
Type: object
Show Source
  • Read Only: true
    Value that indicates if the item is added, changed, or deleted as part of the change order.
  • Title: Approval Status
    Maximum Length: 30
    Status that indicates whether or not the item is approved for use in transactions.
  • Status of the approval sought for item.
  • Value that indicates how the item is tracked as an asset. Values include Customer Asset, Not Tracked, and Full Lifecycle.
  • Email address of the buyer associated with the item.
  • 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.
  • Title: Change Order Number
    Default Value: -1
    Value that uniquely identifies the change line of the component.
  • Number that identifies the change order associated with the item.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who added the item to the change.
  • Title: Create Supply After
    Date after which the supply for the item is considered while generating planned orders.
  • Read Only: true
    Date and time when the item was added to the change.
  • Title: Lifecycle Phase
    Maximum Length: 30
    Abbreviation that identifies the lifecycle phase of the item.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Change Order Implementation Date
    Date when the affected item was implemented.
  • Title: Item Status
    Maximum Length: 10
    The code that uniquely identifies the item status. This attribute is reserved for internal purposes. Do not use.
  • Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the item.
  • 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.
  • 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.
  • Title: Description
    Maximum Length: 240
    Description of the item.
  • ItemEffCategory
  • Value that uniquely identifies the item.
  • Title: Item
    Maximum Length: 300
    Number that identifies the item.
  • Item Revisions
    Title: Item Revisions
    The Item Revisions resource gets the revision associated with the affected item in the change order.
  • 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
  • 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.
  • Read Only: true
    Date and time when the affected item was most recently updated.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the affected item in the change.
  • Read Only: true
    Maximum Length: 32
    Login of the user who most recently updated the item in the change.
  • Value that indicates the lifecycle phase of an item.
  • Links
  • Abbreviation that identifies the organization of the item.
  • 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.
  • Read Only: true
    Value that uniquely identifies the organization of the item.
  • Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the organization of the item.
  • 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.
  • 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.
  • Title: Primary Unit of Measure
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the item uses.
  • Unit that is primarily used to measure quantities of the item.
  • 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.
  • Value that uniquely identifies the request.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 : ItemEffCategory
Type: array
Show Source
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 : ItemSupplierAssociation
Type: array
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemEffCategory-item-response
Type: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-item-response
Type: object
Show Source
Nested Schema : ItemRevisionEffCategory
Type: array
ItemService.ItemRevisionEffCategory
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response
Type: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemSupplierAssociation-item-response
Type: object
Show Source
Nested Schema : ItemSupplierEffCategory
Type: array
ItemService.ItemSupplierEffCategory
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemSupplierAssociation-ItemSupplierEffCategory-item-response
Type: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemAML-item-response
Type: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemAttachment-item-response
Type: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-item-response
Type: object
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: object
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: object
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: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-AffectedItemStructure-StructureComponent-RedlinedSubstituteComponent-item-response
Type: object
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: object
Show Source
Nested Schema : productChangeOrders-AffectedObject-ChangeLineDFF-item-response
Type: object
Show Source
Links
AffectedItem
Parameters:
  • AffectedObjectUniqID: $request.path.AffectedObjectUniqID
  • ChangeId: $request.path.ChangeId
The Affected Items resource gets the items in the change order.
AffectedItemAML
Parameters:
  • AffectedObjectUniqID: $request.path.AffectedObjectUniqID
  • ChangeId: $request.path.ChangeId
The Affected Item AMLs resource gets the approved manufacturers of an item in a change order.
AffectedItemAttachment
Parameters:
  • AffectedObjectUniqID: $request.path.AffectedObjectUniqID
  • ChangeId: $request.path.ChangeId
The Affected Item Attachments resource gets the attachments of an affected item in the change order.
AffectedItemStructure
Parameters:
  • AffectedObjectUniqID: $request.path.AffectedObjectUniqID
  • ChangeId: $request.path.ChangeId
The Affected Item Structures resource gets the details of the structure of the affected item.
ChangeLineDFF
Parameters:
  • AffectedObjectUniqID: $request.path.AffectedObjectUniqID
  • ChangeId: $request.path.ChangeId
The Flexfields for Change Lines resource gets the descriptive flexfields associated with the change line.
Back to Top

Examples

This example describes how to get one affected item.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/productChangeOrders/ChangeId/child/AffectedObject/ChangeLineId"

For example, the following command gets one affected item where the change line identifier is 00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6:

curl -u username:password "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject/00020000000EACED00057708000110F0835210C60000000EACED00057708000110F0835210C6"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "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"
        }
    ]
}
Back to Top