Get all replacement lines
get
/fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}/child/massReplacementLines
Request
Path Parameters
-
ReplacementId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Find replacement line according to the primary key.
Finder Variables- ReplacementDetailId; integer; Value that uniquely identifies the replacement line entity.
- findByAccessBasedReplacementOrgs Finds replacement headers and details based on the replacement organizations to which the user has data access.
Finder Variables
- PrimaryKey Find replacement line according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AltSupplierId; integer; Value that uniquely identifies the alternate supplier used as a replacement option.
- AltSupplierName; string; Name of the alternate supplier used as a replacement option.
- AltSupplierSite; string; Name of the alternate supplier site used as a replacement option.
- AltSupplierSiteId; integer; Value that uniquely identifies the alternate supplier site used as a replacement option.
- AlternateItemImageURL; string; URL of the alternate item image uploaded in item master.
- CopyFromDisruptedItemFlag; boolean; Attribute that indicates whether the inventory entities must be copied from the original item or not.
- CopyFromDisruptedTransactionFlag; boolean; Attribute that indicates whether the item transaction defaults must be copied from the disrupted item or not.
- DetailInvStatus; string; Indicates the status name of the replacement lifecycle for inventory entities at the inventory organization level.
- DetailInvStatusCode; string; Indicates the status code of the replacement lifecycle for inventory entities at the inventory organization level.
- DetailStatus; string; Indicates the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at global organization level in case of global replacement.
- DetailStatusCode; string; Indicates the lookup type code for the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at the global organization level in case of global replacement.
- GroupId; integer; Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
- ObjectVersionNumber; integer; Number of times the replacement line has been updated.
- Organization; string; Name of the organization in which replacement is initiated for a replacement header.
- OrganizationCode; string; Abbreviation that identifies the organization in which replacement is initiated for a replacement header.
- OrganizationId; integer; Value that uniquely identifies the organization in which replacement is initiated for a replacement header.
- PrimaryUnitOfMeasure; string; Attribute indicating the name of the primary unit of measure for the replacement item.
- PurchasingUnitOfMeasure; string; Attribute indicating the name of the purchasing unit of measure for the replacement item.
- ReinstateReplenishNotifyFlag; boolean; Attribute indicating that the replacement option is notified for reinstating the replenishment attributes.
- ReinstateRequestId; integer; Value that uniquely identifies the request for the mass replacement scheduled job submitted during the reinstate phase of the replacement life cycle.
- ReinstateSrcDocumentLineNumber; number; Number that identifies the primary source document line.
- ReinstateSrcDocumentNumber; string; Number that identifies the primary source document.
- ReplacementDetailId; integer; Value that uniquely identifies the replacement line.
- ReplacementEndDate; string; Date on which the reinstate action gets initiated for a replacement organization or globally across organizations.
- ReplacementId; integer; Value that uniquely identifies the replacement header.
- ReplacementReplenishNotifyFlag; boolean; Attribute indicating that the replacement option is notified for updating the replenishment attributes.
- ReplacementRequestId; integer; Value that uniquely identifies the request for the mass replacement scheduled job submitted during replacement phase of the replacement lifecycle.
- ReplacementStartDate; string; Date on which the replacement action gets initiated for a replacement organization or globally across organizations.
- ReplenishByInvSourceFlag; boolean; Attribute that indicates whether item subinventories with inventory as the replenishment source must be replaced or not.
- RequestId; integer; Value that uniquely identifies the request for the mass replacement scheduled process during item replacement.
- RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit.
- RequisitioningBUName; string; Name of the requisitioning business unit.
- SourceDocumentLineNumber; number; Number that identifies the alternate source document line.
- SourceDocumentNumber; string; Number that identifies the alternate source document.
- SubstituteItemDescription; string; Description of the substitute internal item.
- SubstituteItemId; integer; Value that uniquely identifies the substitute internal item.
- SubstituteItemNumber; string; Number that identifies the substitute internal item.
- SubstituteMPNId; integer; Value that uniquely identifies the alternate manufacturer part number.
- SubstituteManufacturerPartNumber; string; Number that identifies the substitute manufacturer part number.
- SubstituteType; string; Replacement method selected for a replacement organization or globally across organizations indicating whether it's an alternate supplier or alternate item.
- SubstituteTypeCode; string; Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations.
- SupplierPartNumber; string; Attribute indicating the supplier item number for the replacement item.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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.
Root Schema : massReplacementHeaders-massReplacementLines
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : massReplacementHeaders-massReplacementLines-item-response
Type:
Show Source
object
-
AlternateItemImageURL: string
Title:
Primary Image URL
Read Only:true
Maximum Length:4000
URL of the alternate item image uploaded in item master. -
AltSupplierId: integer
(int64)
Value that uniquely identifies the alternate supplier used as a replacement option.
-
AltSupplierName: string
Maximum Length:
360
Name of the alternate supplier used as a replacement option. -
AltSupplierSite: string
Title:
Site
Maximum Length:240
Name of the alternate supplier site used as a replacement option. -
AltSupplierSiteId: integer
(int64)
Value that uniquely identifies the alternate supplier site used as a replacement option.
-
CopyFromDisruptedItemFlag: boolean
Maximum Length:
1
Attribute that indicates whether the inventory entities must be copied from the original item or not. -
CopyFromDisruptedTransactionFlag: boolean
Maximum Length:
1
Attribute that indicates whether the item transaction defaults must be copied from the disrupted item or not. -
DetailInvStatus: string
Title:
Meaning
Read Only:true
Maximum Length:80
Indicates the status name of the replacement lifecycle for inventory entities at the inventory organization level. -
DetailInvStatusCode: string
Maximum Length:
30
Indicates the status code of the replacement lifecycle for inventory entities at the inventory organization level. -
DetailStatus: string
Title:
Meaning
Maximum Length:80
Indicates the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at global organization level in case of global replacement. -
DetailStatusCode: string
Maximum Length:
30
Indicates the lookup type code for the status of the replacement lifecycle at the organization level in case of organization-specific replacement or at the global organization level in case of global replacement. -
GroupId: integer
(int64)
Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
-
InvExceptionFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether there is an exception for the replacement detail during mass replacement on inventory entities. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
massReplacementPODetails: array
Mass Replacement Purchase Order Details
Title:
Mass Replacement Purchase Order Details
The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement. -
NewItemLocFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether a new item locator is added to the replacement item during the item replacement process. -
NewItemSubFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether a new item subinventory is added to the replacement item during the item replacement process. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement line has been updated.
-
Organization: string
Maximum Length:
240
Name of the organization in which replacement is initiated for a replacement header. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization in which replacement is initiated for a replacement header. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization in which replacement is initiated for a replacement header.
-
PackagingString: string
Read Only:
true
Maximum Length:255
Value that indicates the packaging string of the replacement item. -
PrimaryUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Attribute indicating the name of the primary unit of measure for the replacement item. -
PurchasingUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Attribute indicating the name of the purchasing unit of measure for the replacement item. -
ReinstateReplenishNotifyFlag: boolean
Maximum Length:
1
Attribute indicating that the replacement option is notified for reinstating the replenishment attributes. -
ReinstateRequestId: integer
(int64)
Value that uniquely identifies the request for the mass replacement scheduled job submitted during the reinstate phase of the replacement life cycle.
-
ReinstateSrcDocumentLineNumber: number
Number that identifies the primary source document line.
-
ReinstateSrcDocumentNumber: string
Maximum Length:
30
Number that identifies the primary source document. -
ReplacementDetailId: integer
(int64)
Value that uniquely identifies the replacement line.
-
ReplacementEndDate: string
(date)
Date on which the reinstate action gets initiated for a replacement organization or globally across organizations.
-
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
-
ReplacementReplenishNotifyFlag: boolean
Maximum Length:
1
Attribute indicating that the replacement option is notified for updating the replenishment attributes. -
ReplacementRequestId: integer
(int64)
Value that uniquely identifies the request for the mass replacement scheduled job submitted during replacement phase of the replacement lifecycle.
-
ReplacementStartDate: string
(date)
Date on which the replacement action gets initiated for a replacement organization or globally across organizations.
-
ReplenishByInvSourceFlag: boolean
Maximum Length:
1
Attribute that indicates whether item subinventories with inventory as the replenishment source must be replaced or not. -
RequestId: integer
(int64)
Value that uniquely identifies the request for the mass replacement scheduled process during item replacement.
-
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning business unit.
-
RequisitioningBUName: string
Title:
Business Unit
Maximum Length:240
Name of the requisitioning business unit. -
SourceDocumentLineNumber: number
Number that identifies the alternate source document line.
-
SourceDocumentNumber: string
Maximum Length:
30
Number that identifies the alternate source document. -
StuckInProgressFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether the replacement detail task got stuck while performing mass updates on inventory entities because mass replacement scheduled processes were canceled before they started running. -
SubstituteItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the substitute internal item. -
SubstituteItemId: integer
(int64)
Value that uniquely identifies the substitute internal item.
-
SubstituteItemNumber: string
Maximum Length:
300
Number that identifies the substitute internal item. -
SubstituteManufacturerPartNumber: string
Title:
Trading Partner Item
Maximum Length:150
Number that identifies the substitute manufacturer part number. -
SubstituteMPNId: integer
(int64)
Value that uniquely identifies the alternate manufacturer part number.
-
SubstituteType: string
Title:
Meaning
Maximum Length:80
Replacement method selected for a replacement organization or globally across organizations indicating whether it's an alternate supplier or alternate item. -
SubstituteTypeCode: string
Maximum Length:
30
Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations. -
SupplierPartNumber: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Attribute indicating the supplier item number for the replacement item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mass Replacement Purchase Order Details
Type:
array
Title:
Mass Replacement Purchase Order Details
The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.
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 : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response
Type:
Show Source
object
-
InlineReplacementFlag: boolean
Maximum Length:
1
Default Value:false
Attribute that indicates whether inline replacement is performed on the purchase order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PODetailId: integer
(int64)
Value that uniquely identifies the purchase order detail for which replacement is done.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution for which replacement is done.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header for which replacement is done.
-
POLineId: integer
(int64)
Value that uniquely identifies the purchase order line for which replacement is done.
-
POLineLocationId: integer
(int64)
Value that uniquely identifies the purchase order schedule for which replacement is done.
-
POStatus: string
Maximum Length:
30
Attribute that indicates the status of the mass replacement for a purchase order detail record. -
QuantityDue: number
Indicates the order quantity for the replacement line to be created on the purchase order.
-
ReplacementAction: string
Maximum Length:
30
Indicates whether mass update is done against a purchase order detail record for a replacement action or a reinstate action. -
ReplacementDetailId: integer
(int64)
Value that uniquely identifies the replacement line.
-
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- massReplacementOnInventoryEntities
-
Parameters:
- ReplacementId:
$request.path.ReplacementId
Action to update mass replacement options, update the inventory status for the replacement tasks at the organization level, and submit the mass replacement scheduled process during item replacement on inventory entities. - ReplacementId: