Get one change order
get
/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}
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 -
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-item-response
Type:
Show Source
object
-
AffectedObject: array
Affected Objects
Title:
Affected Objects
The Affected Objects resource gets the details of the affected objects added to the change order. -
ApprovalDate: string
(date-time)
Read Only:
true
Date when the change was approved. -
ApprovalRequestDate: string
(date-time)
Read Only:
true
Date when this change order was sent for approval. -
ApprovalStatus: integer
(int64)
Read Only:
true
Status of approval of the change order. -
ApprovalStatusValue: string
Read Only:
true
Value that indicates the approval status of the change object. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. -
AssignedTo: string
User who the application assigned to the change object.
-
AssignedToRole: string
Role that is used to define users to whom the change object can be assigned.
-
AssigneeId: string
Maximum Length:
100
Value that uniquely identifies the user assigned to the change object. -
Attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the attachments of a change order. -
BaseChangeMgmtTypeCode: string
Maximum Length:
30
Default Value:CHANGE_ORDER
The base change management type code of the change object. -
CancellationDate: string
(date-time)
Read Only:
true
Date when this change order was canceled. -
CanUpdate: string
Value that indicates if a change order can be updated.
-
changeApprovers: array
Approvers
Title:
Approvers
The Approvers resource manages the approvers assigned to a change order status. -
ChangeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the change. -
ChangeName: string
Title:
Name
Maximum Length:240
Name of the change object. -
ChangeNotice: string
Title:
Number
Maximum Length:50
Value that uniquely identifies the change object. -
ChangeObjectDFF: array
Flexfields for Change Orders
Title:
Flexfields for Change Orders
The Flexfields for Change Orders resource gets the descriptive flexfields associated with the change order. -
changeRequestAffectedItems: array
Affected Items for Change Requests
Title:
Affected Items for Change Requests
The Affected Items for Change Requests resource gets the affected items for change requests. -
ChangeTypeId: integer
(int64)
Value that uniquely identifies the type of change object.
-
ChangeTypeValue: string
Maximum Length:
255
Value that determines the type of change. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Order Types task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the change object. -
CreationDate: string
(date-time)
Read Only:
true
Date when the change object was created. -
Description: string
Title:
Description
Maximum Length:2000
Description of the change object. -
EffectiveImmediatelyFlag: boolean
Read Only:
true
Maximum Length:5
Contains one of the following values: true or false. If true, then the change order is effective immediately. If false, then the change order is not effective immediately. The default value is false. -
EffectivityIncrementDays: integer
Read Only:
true
Number of days by which the effective date of the change object is incremented. -
ImplementationDate: string
(date-time)
Read Only:
true
Date when this change order was implemented. -
InitiationDate: string
(date-time)
Read Only:
true
Date when the workflow corresponding to the change order was started. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the change object was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the change object. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the change order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date-time)
Date by when the change is expected to be completed.
-
nextStatuses: array
Next Statuses
Title:
Next Statuses
The Next Statuses resource gets the next possible statuses for a change order. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the change object. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization of the change object.
-
PriorityCode: string
Maximum Length:
30
Abbreviation that identifies the priority of the change object. -
PriorityCodeValue: string
Maximum Length:
255
Value that determines the priority of the change object. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Priorities task. -
ReasonCode: string
Maximum Length:
30
Abbreviation that identifies the reason for the change. -
ReasonCodeValue: string
Maximum Length:
255
Value that determines the reason for the change order. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Reasons task. -
relationships: array
Relationships
Title:
Relationships
The Relationships resource manages the objects related to the change order. -
RequestedBy: string
User who requested the change object.
-
RequestorId: string
Maximum Length:
100
Value that uniquely identifies the user who requested the change object. -
SourceTypeCode: string
Read Only:
true
Maximum Length:30
Value that identifies the source type from which this change order was created. You can create different types of change orders by using one of the existing types as the source. -
StatusCode: integer
(int64)
Read Only:
true
Default Value:0
Abbreviation that identifies the status of the change object. -
StatusCodeValue: string
Read Only:
true
Abbreviation that identifies the status of the change object. Valid values are open, interim approval, approval, scheduled, and completed. -
StatusType: integer
(int64)
Read Only:
true
Default Value:0
Type of status of the change object. Valid values are open, interim approval, approval, scheduled, and completed. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Statuses task. -
StatusTypeValue: string
Read Only:
true
Value of the status type of the change object. Valid values are open, interim approval, approval, scheduled, and completed. -
tasks: array
Tasks
Title:
Tasks
The Tasks resource manages the tasks related to the change order. -
team: array
Teams
Title:
Teams
The Teams resource manages the users who are authorized to access the change order. -
WfProcessInstanceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow associated with this change order. -
WfProcessTemplate: string
Read Only:
true
Maximum Length:400
Template of the workflow associated with the change order. Review and update the change type associated with a workflow using the Setup and Maintenance work area, and the Manage Change Order Types task.
Nested Schema : Affected Objects
Type:
array
Title:
Affected Objects
The Affected Objects resource gets the details of the affected objects added to the change order.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the attachments of a change order.
Show Source
Nested Schema : Approvers
Type:
array
Title:
Approvers
The Approvers resource manages the approvers assigned to a change order status.
Show Source
Nested Schema : Flexfields for Change Orders
Type:
array
Title:
Flexfields for Change Orders
The Flexfields for Change Orders resource gets the descriptive flexfields associated with the change order.
Show Source
Nested Schema : Affected Items for Change Requests
Type:
array
Title:
Affected Items for Change Requests
The Affected Items for Change Requests resource gets the affected items for change requests.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Next Statuses
Type:
array
Title:
Next Statuses
The Next Statuses resource gets the next possible statuses for a change order.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The Relationships resource manages the objects related to the change order.
Show Source
Nested Schema : Tasks
Type:
array
Title:
Tasks
The Tasks resource manages the tasks related to the change order.
Show Source
Nested Schema : Teams
Type:
array
Title:
Teams
The Teams resource manages the users who are authorized to access the change order.
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
Nested Schema : productChangeOrders-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the change object. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created 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 attached file. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the file attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attached document was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the change object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-changeApprovers-item-response
Type:
Show Source
object
-
Approverflag: string
Maximum Length:
255
Contains one of the following values: true or false. If true, then an approver is mandatory. If false, then an approver is optional. This attribute does not have a default value. -
AssigneeName: string
Maximum Length:
400
Name of the user or role that is assigned as an approver. -
AssigneeTypeCode: string
Maximum Length:
20
Abbreviation that identifies the type of approver. Valid values include role and user. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalAssigneeType: string
Maximum Length:
30
Name of the role from which this user assignment originated. -
ResponseRequiredFrom: string
Maximum Length:
10
Value that indicates if approval is requested from one or all of the approvers. -
StatusCode: integer
Abbreviation that identifies the workflow status.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-ChangeObjectDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for change objects. -
BaseChangeMgmtTypeCode: string
Maximum Length:
30
Abbreviation that identifies the base change management type of the change object. -
ChangeId: integer
(int64)
Value that uniquely identifies the change order.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-changeRequestAffectedItems-item-response
Type:
Show Source
object
-
ChangeLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the affected item in a change request. -
changeRequestAffectedItemsDFF: array
Flexfields for Affected Items in Change Requests
Title:
Flexfields for Affected Items in Change Requests
The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests. -
ItemId: integer
(int64)
Value that uniquely identifies an item in a change request.
-
ItemNumber: string
Maximum Length:
255
Number that identifies the item. -
LifecycleStateId: integer
(int64)
Value that uniquely identifies the lifecycle phase of the affected item in the change request.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number that identifies the version of the affected item in the change request.
-
Revision: string
Maximum Length:
255
Revision of the item. -
RevisionId: integer
(int64)
Value that uniquely identifies a revision of a item in a change request.
-
SequenceNumber: integer
Number that uniquely identifies the sequence of an affected item in a change request.
Nested Schema : Flexfields for Affected Items in Change Requests
Type:
array
Title:
Flexfields for Affected Items in Change Requests
The Flexfields for Affected Items in Change Requests resource gets the flexfields for affected items used in change requests.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-changeRequestAffectedItems-changeRequestAffectedItemsDFF-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
Nested Schema : productChangeOrders-nextStatuses-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SequenceNumber: number
Read Only:
true
Sequence number of the status in the change object workflow. -
StatusCode: integer
Read Only:
true
Abbreviation that identifies the status of a change object. -
StatusCodeName: string
Read Only:
true
Maximum Length:80
Name of the status of a change object. -
StatusTypeName: string
Read Only:
true
Maximum Length:80
Name of the status type of the status of a change object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-relationships-item-response
Type:
Show Source
object
-
ChangeNotice: string
Read Only:
true
Maximum Length:255
Number that identifies the change order associated with the item. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
true
Date when the relationship was created. -
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30
Value that indicates the type of the destination object. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the relationship was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the relationship. -
LatestFlag: boolean
Value that indicates whether the related object is latest or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the related object.
-
RelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the relationship of a change. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
Value that indicates the type of the relationship. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30
Value that indicates the type of the source object. -
Status: string
Status of the related object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-tasks-item-response
Type:
Show Source
object
-
AssignedTo: string
User to whom the change object is assigned.
-
CompleteBeforeStatusCode: integer
(int64)
Abbreviation that identifies the change object status before by which the task should be marked as completed.
-
Description: string
Maximum Length:
2000
Description of the task in the change object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
240
Name of the task. -
NeedByDate: string
(date-time)
Date when the change is expected to be completed.
-
RequiredFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the task is required to be completed prior to the complete before status. If false, then the task is not required to be completed prior to any status. The default value is false. -
SequenceNumber: integer
Sequence number of the task in the change object. Each task must have a unique sequence number within the change object.
-
StartAfterStatusCode: integer
(int64)
Abbreviation that identifies the change object status after which the task can be marked as completed.
-
StatusCode: integer
(int64)
Abbreviation that identifies the status of the task. Valid values are Open, Completed, and Canceled. If this attribute value is Completed or Canceled, only this attribute can be updated. All other attributes are not editable.
-
TaskId: integer
(int64)
Read Only:
true
Value that uniquely identifies the task in the change object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrders-team-item-response
Type:
Show Source
object
-
GranteeName: string
Maximum Length:
4000
Name of the user or the user group. -
GranteeType: string
Title:
Grantee Type
Maximum Length:30
Value that indicates whether the type of team member is a user or a user group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AffectedObject
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Affected Objects resource gets the details of the affected objects added to the change order. - ChangeId:
- Attachments
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Attachments resource gets the attachments of a change order. - ChangeId:
- ChangeObjectDFF
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Flexfields for Change Orders resource gets the descriptive flexfields associated with the change order. - ChangeId:
- changeApprovers
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Approvers resource manages the approvers assigned to a change order status. - ChangeId:
- changeRequestAffectedItems
-
Operation: /fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/changeRequestAffectedItemsParameters:
- ChangeId:
$request.path.ChangeId
The Affected Items for Change Requests resource gets the affected items for change requests. - ChangeId:
- nextStatuses
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Next Statuses resource gets the next possible statuses for a change order. - ChangeId:
- relationships
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Relationships resource manages the objects related to the change order. - ChangeId:
- tasks
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Tasks resource manages the tasks related to the change order. - ChangeId:
- team
-
Parameters:
- ChangeId:
$request.path.ChangeId
The Teams resource manages the users who are authorized to access the change order. - ChangeId:
Examples
This example describes how to get one change order.
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"
For example, the following command gets one change order where the change identifier is 300100158099400:
curl -u username:password "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ChangeId": 300100158099400, "BaseChangeMgmtTypeCode": "CHANGE_ORDER", "ChangeTypeId": 300100110514407, "ChangeNotice": "REST_Sample_Change_Order", "ChangeName": "REST_Sample_Change_Order", "Description": null, "OrganizationId": 204, "PriorityCode": "HIGH", "ReasonCode": null, "ApprovalDate": null, "ChangeTypeValue": "ORA_ENG_CO", "OrganizationCode": "V1", "PriorityCodeValue": "High", "ReasonCodeValue": null, "NeedByDate": null, "CanUpdate": "Y", "AssigneeId": "71C7C80A48E3C2BDB42CB4269BAC82DD", "RequestorId": "71C7C80A48E3C2BDB42CB4269BAC82DD", "AssignedTo": "PIMQA", "RequestedBy": "PIMQA", "SourceTypeCode": "ENG_CO", "StatusType": 0, "StatusCode": 0, "ApprovalStatus": 1, "StatusTypeValue": "Draft", "StatusCodeValue": "Draft", "ApprovalStatusValue": "Not submitted for approval", "EffectiveImmediatelyFlag": true, "EffectivityIncrementDays": 1, "InitiationDate": "2018-06-22T00:00:00+00:00", "ImplementationDate": null, "CancellationDate": null, "ApprovalRequestDate": null, "WfProcessInstanceId": null, "WfProcessTemplate": null, "CreatedBy": "PIMQA", "CreationDate": "2018-06-22T07:30:07+00:00", "LastUpdatedBy": "PIMQA", "LastUpdateDate": "2018-06-22T07:30:07.202+00:00", "LastUpdateLogin": "6F355DFFC393213EE0537328F70AA25C", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400", "name": "productChangeOrders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400", "name": "productChangeOrders", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/PrioritiesLookupPVO1", "name": "PrioritiesLookupPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/StatusTypeLookupPVO1VA", "name": "StatusTypeLookupPVO1VA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/LOVForChangeType1", "name": "LOVForChangeType1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/ChangeStatusVOStatusCodeLOVVA", "name": "ChangeStatusVOStatusCodeLOVVA", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/ApprovalStatusTypesLookupPVO", "name": "ApprovalStatusTypesLookupPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/UserPVO1", "name": "UserPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/ReasonsLookupPVO1", "name": "ReasonsLookupPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/UserPVO2", "name": "UserPVO2", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/lov/LOVForOrganization", "name": "LOVForOrganization", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/Attachments", "name": "Attachments", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/ChangeObjectDFF", "name": "ChangeObjectDFF", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/changeRequestAffectedItems", "name": "changeRequestAffectedItems", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/productChangeOrders/300100158099400/child/AffectedObject", "name": "AffectedObject", "kind": "collection" } ] }