Create replacement headers
post
/fscmRestApi/resources/11.13.18.05/massReplacementHeaders
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DisruptionReasonCode: string
Maximum Length:
30
Attribute that stores the user-defined lookup code that represents the reason for supply disruption. This attribute is captured while creating the replacement task. -
EstimatedEndDate: string
(date)
Attribute that stores the expected date on which the supply may be restored for the disrupted item. This attribute is captured while creating the replacement task.
-
ManufacturerPartId: integer
(int64)
Value that uniquely identifies the primary manufacturer part number.
-
ManufacturerPartNumber: string
Title:
Trading Partner Item
Maximum Length:150
Number that identifies the primary manufacturer part. -
massReplacementGroupedOrgs: array
Mass Replacement Grouped Organizations
Title:
Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process. -
massReplacementLines: array
Mass Replacement Lines
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement header has been updated.
-
PrimaryItemId(required): integer
(int64)
Value that uniquely identifies the primary internal item.
-
PrimaryItemNumber(required): string
Maximum Length:
300
Number that identifies the primary internal item. -
ProcurementBUId(required): integer
(int64)
Value that uniquely identifies the procurement business unit.
-
ProcurementBUName(required): string
Title:
Business Unit
Maximum Length:240
Name of the procurement business unit. -
ReplacementDefType: string
Title:
Meaning
Maximum Length:80
Type of item number used to define a replacement indicating whether it's an MPN or an internal item. -
ReplacementDefTypeCode(required): string
Maximum Length:
30
Lookup code of item number type used to define a replacement indicating whether it's an MPN or an internal item. -
ReplacementEndDate: string
(date)
Date on which reinstate action gets initiated for a replacement definition.
-
ReplacementHeaderStatus: string
Title:
Meaning
Maximum Length:80
Status of the replacement header. -
ReplacementHeaderStatusCode(required): string
Maximum Length:
30
Lookup value code of replacement header status. -
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
-
ReplacementLevelType: string
Title:
Meaning
Maximum Length:80
Indicates whether the level of replacement is specific to an inventory organization or applicable across organizations. -
ReplacementLevelTypeCode(required): string
Maximum Length:
30
Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations. -
ReplacementStartDate: string
(date)
Date on which replacement action gets initiated for a replacement definition.
-
ReplacementType: string
Title:
Meaning
Maximum Length:80
Type of replacement indicating whether it's permanent or temporary. -
ReplacementTypeCode(required): string
Maximum Length:
30
Lookup code of the replacement type indicating whether it's permanent or temporary. -
SupplierId(required): integer
(int64)
Value that uniquely identifies the primary supplier for which replacement is defined.
-
SupplierName(required): string
Maximum Length:
360
Name of the supplier for which replacement is defined. -
SupplierSite(required): string
Title:
Site
Maximum Length:240
Name of the supplier site for which replacement is defined. -
SupplierSiteId(required): integer
(int64)
Value that uniquely identifies the primary supplier site for which replacement is defined.
Nested Schema : Mass Replacement Grouped Organizations
Type:
array
Title:
Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.
Show Source
Nested Schema : Mass Replacement Lines
Type:
array
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.
Show Source
Nested Schema : massReplacementHeaders-massReplacementGroupedOrgs-item-post-request
Type:
Show Source
object
-
GroupId: integer
(int64)
Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
-
OrganizationId: integer
(int64)
Unique identifier for the organizations in a group for which item replacement is performed.
-
ReplacementId: integer
(int64)
Unique identifier of the replacement task in which organizations are grouped to perform item replacement.
-
ReplacementOrgId: integer
(int64)
Unique identifier for the grouped organizations in the item replacement task.
-
RequisitioningBUId: integer
(int64)
Unique identifier for the requisitioning business units that correspond to the organizations in a group for which item replacement is performed.
Nested Schema : massReplacementHeaders-massReplacementLines-item-post-request
Type:
Show Source
object
-
AltSupplierId(required): integer
(int64)
Value that uniquely identifies the alternate supplier used as a replacement option.
-
AltSupplierName(required): string
Maximum Length:
360
Name of the alternate supplier used as a replacement option. -
AltSupplierSite(required): string
Title:
Site
Maximum Length:240
Name of the alternate supplier site used as a replacement option. -
AltSupplierSiteId(required): 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. -
DetailInvStatusCode: string
Maximum Length:
30
Indicates the status code of the replacement lifecycle for inventory entities at the inventory organization level. -
DetailStatus(required): 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(required): 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.
-
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. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement line has been updated.
-
Organization(required): string
Maximum Length:
240
Name of the organization in which replacement is initiated for a replacement header. -
OrganizationId(required): integer
(int64)
Value that uniquely identifies the organization in which replacement is initiated for a replacement header.
-
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(required): 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(required): integer
(int64)
Value that uniquely identifies the requisitioning business unit.
-
RequisitioningBUName(required): string
Title:
Business Unit
Maximum Length:240
Name of the requisitioning business unit. -
SourceDocumentLineNumber(required): number
Number that identifies the alternate source document line.
-
SourceDocumentNumber(required): string
Maximum Length:
30
Number that identifies the alternate source document. -
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(required): 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(required): string
Maximum Length:
30
Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations.
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 : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-post-request
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. -
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.
Response
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 : massReplacementHeaders-item-response
Type:
Show Source
object
-
DisruptionReason: string
Title:
Meaning
Read Only:true
Maximum Length:80
Attribute that stores the user-defined lookup meaning that represents the reason for supply disruption. This attribute is captured while creating the replacement task. -
DisruptionReasonCode: string
Maximum Length:
30
Attribute that stores the user-defined lookup code that represents the reason for supply disruption. This attribute is captured while creating the replacement task. -
EnableReinstateFlag: boolean
Read Only:
true
Boolean operator to indicate whether to allow the reinstate action for the replacement task based on the inventory status of the replacement detail tasks. Valid values are True and False. -
EstimatedEndDate: string
(date)
Attribute that stores the expected date on which the supply may be restored for the disrupted item. This attribute is captured while creating the replacement task.
-
ExceptionCount: integer
Read Only:
true
Count of errors occurred during mass replacement process. -
LinesCount: integer
Read Only:
true
Count of replacement detail records for a replacement header. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MakePermanentFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether a temporary replacement is made permanent during its life cycle. -
ManufacturerPartId: integer
(int64)
Value that uniquely identifies the primary manufacturer part number.
-
ManufacturerPartNumber: string
Title:
Trading Partner Item
Maximum Length:150
Number that identifies the primary manufacturer part. -
MarkCompleteFlag: boolean
Read Only:
true
Maximum Length:255
Attribute used to indicate the completion of replacement header for a permanent replacement. -
massReplacementGroupedOrgs: array
Mass Replacement Grouped Organizations
Title:
Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process. -
massReplacementLines: array
Mass Replacement Lines
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header. -
ObjectVersionNumber: integer
(int32)
Number of times the replacement header has been updated.
-
PackagingString: string
Read Only:
true
Maximum Length:255
Value that indicates the packaging string of the original item. -
PrimaryItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the primary internal item. -
PrimaryItemId: integer
(int64)
Value that uniquely identifies the primary internal item.
-
PrimaryItemImageURL: string
Title:
Primary Image URL
Read Only:true
Maximum Length:4000
URL of the primary item image uploaded in item master. -
PrimaryItemNumber: string
Maximum Length:
300
Number that identifies the primary internal item. -
PrimaryUnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Attribute indicating the name of the primary unit of measure for the original item. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the procurement business unit.
-
ProcurementBUName: string
Title:
Business Unit
Maximum Length:240
Name of the procurement business unit. -
PurchasingUnitOfMeasure: string
Read Only:
true
Maximum Length:255
Attribute indicating the name of the purchasing unit of measure for the original item. -
ReinstateFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether reinstatement is completed for the replacement task for at least one organization. -
ReinstateGlobalFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether to allow a reinstatement on the replacement detail task by validating its inventory status for each organization in a global replacement. -
ReplacementDefType: string
Title:
Meaning
Maximum Length:80
Type of item number used to define a replacement indicating whether it's an MPN or an internal item. -
ReplacementDefTypeCode: string
Maximum Length:
30
Lookup code of item number type used to define a replacement indicating whether it's an MPN or an internal item. -
ReplacementEndDate: string
(date)
Date on which reinstate action gets initiated for a replacement definition.
-
ReplacementFlag: boolean
Read Only:
true
Maximum Length:255
Attribute that indicates whether the replacement phase is completed for the replacement task for at least one organization. -
ReplacementHeaderStatus: string
Title:
Meaning
Maximum Length:80
Status of the replacement header. -
ReplacementHeaderStatusCode: string
Maximum Length:
30
Lookup value code of replacement header status. -
ReplacementId: integer
(int64)
Value that uniquely identifies the replacement header.
-
ReplacementLevelType: string
Title:
Meaning
Maximum Length:80
Indicates whether the level of replacement is specific to an inventory organization or applicable across organizations. -
ReplacementLevelTypeCode: string
Maximum Length:
30
Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations. -
ReplacementNumber: integer
(int64)
Read Only:
true
Number that uniquely identifies the replacement header. -
ReplacementStartDate: string
(date)
Date on which replacement action gets initiated for a replacement definition.
-
ReplacementType: string
Title:
Meaning
Maximum Length:80
Type of replacement indicating whether it's permanent or temporary. -
ReplacementTypeCode: string
Maximum Length:
30
Lookup code of the replacement type indicating whether it's permanent or temporary. -
SubItemNotAssignedFlag: boolean
Read Only:
true
Attribute indicating that the substitute item isn't assigned to one or more organizations for a global replacement task. -
SupplierId: integer
(int64)
Value that uniquely identifies the primary supplier for which replacement is defined.
-
SupplierName: string
Maximum Length:
360
Name of the supplier for which replacement is defined. -
SupplierPartNumber: string
Read Only:
true
Maximum Length:255
Attribute indicating the supplier item number for the original item. -
SupplierSite: string
Title:
Site
Maximum Length:240
Name of the supplier site for which replacement is defined. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the primary supplier site for which replacement is defined.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mass Replacement Grouped Organizations
Type:
array
Title:
Mass Replacement Grouped Organizations
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.
Show Source
Nested Schema : Mass Replacement Lines
Type:
array
Title:
Mass Replacement Lines
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.
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-massReplacementGroupedOrgs-item-response
Type:
Show Source
object
-
GroupId: integer
(int64)
Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organizations in a group for which item replacement is performed. -
OrganizationId: integer
(int64)
Unique identifier for the organizations in a group for which item replacement is performed.
-
OrganizationName: string
Read Only:
true
Maximum Length:240
Name of the organizations in a group for which item replacement is performed. -
ReplacementId: integer
(int64)
Unique identifier of the replacement task in which organizations are grouped to perform item replacement.
-
ReplacementOrgId: integer
(int64)
Unique identifier for the grouped organizations in the item replacement task.
-
RequisitioningBUId: integer
(int64)
Unique identifier for the requisitioning business units that correspond to the organizations in a group for which item replacement is performed.
-
RequisitioningBUName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Names of the requisitioning business units that correspond to the organizations in a group for which item replacement is performed.
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 : 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
- massReplacementGroupedOrgs
-
Parameters:
- ReplacementId:
$request.path.ReplacementId
The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process. - ReplacementId:
- massReplacementLines
-
Operation: /fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}/child/massReplacementLinesParameters:
- ReplacementId:
$request.path.ReplacementId
The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header. - ReplacementId:
Examples
This example describes how to create replacement headers.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/massReplacementHeaders"
Example Request Body
The following example includes the contents of the request body in JSON format:
"{ "parts": [ { "id": "part1", "path": "/massReplacementHeaders/", "operation": "create", "payload": { "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementTypeCode": "ORA_SCH_PR_TEMPORARY", "ProcurementBUId": 300100200125593, "PrimaryItemId": 300100545228228, "SupplierId": 6134, "SupplierSiteId": 300100203539381 } }, { "id": "part2", "path": "/massReplacementHeaders/", "operation": "create", "payload": { "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementTypeCode": "ORA_SCH_PR_TEMPORARY", "ProcurementBUId": 300100200125593, "PrimaryItemId": 300100545303414, "SupplierId": 6134, "SupplierSiteId": 300100203539381 } } ] }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "items": [ { "ReplacementId": 300100552611876, "ReplacementNumber": 1, "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementLevelType": "Each organization individually", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementDefType": "Master item", "ReplacementTypeCode": "ORA_SCH_PR_TEMPORARY", "ReplacementType": "Temporary", "PrimaryItemNumber": "SCH1020", "PrimaryItemDescription": "Z-Med 12 Pacemaker", "PrimaryItemId": 300100545228228, "ManufacturerPartNumber": null, "ManufacturerPartId": null, "SupplierName": "Supplier01 Inc", "SupplierId": 6134, "SupplierSite": "VHS Supplier01", "SupplierSiteId": 300100203539381, "ProcurementBUName": "Vision Healthcare USA", "ProcurementBUId": 300100200125593, "ReplacementHeaderStatusCode": "ORA_SCH_PR_OPEN", "ReplacementHeaderStatus": "In-Progress", "ReplacementStartDate": null, "ReplacementEndDate": null, "ObjectVersionNumber": 1, "ExceptionCount": 0, "LinesCount": 0, "MakePermanentFlag": "true", "MarkCompleteFlag": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876", "name": "massReplacementHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876", "name": "massReplacementHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100552611876/child/massReplacementLines", "name": "massReplacementLines", "kind": "collection" } ] }, { "ReplacementId": 300100553117194, "ReplacementNumber": 1005, "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG", "ReplacementLevelType": "Each organization individually", "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM", "ReplacementDefType": "Master item", "ReplacementTypeCode": "ORA_SCH_PR_TEMPORARY", "ReplacementType": "Temporary", "PrimaryItemNumber": "SCH2020", "PrimaryItemDescription": "Z-Med 12 Pacemaker", "PrimaryItemId": 300100545303414, "ManufacturerPartNumber": null, "ManufacturerPartId": null, "SupplierName": "Supplier01 Inc", "SupplierId": 6134, "SupplierSite": "VHS Supplier01", "SupplierSiteId": 300100203539381, "ProcurementBUName": "Vision Healthcare USA", "ProcurementBUId": 300100200125593, "ReplacementHeaderStatusCode": "ORA_SCH_PR_OPEN", "ReplacementHeaderStatus": "In-Progress", "ReplacementStartDate": "2022-04-14", "ReplacementEndDate": null, "ObjectVersionNumber": 2, "ExceptionCount": 0, "LinesCount": 1, "MakePermanentFlag": "false", "MarkCompleteFlag": "false", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194", "name": "massReplacementHeaders", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194", "name": "massReplacementHeaders", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117194/child/massReplacementLines", "name": "massReplacementLines", "kind": "collection" } ] } ] }"