Jump to

• Request
• Response
• Examples

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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 is MPN or internal item.
• ReplacementDefTypeCode(required): string
  Maximum Length: 30

  Look up value code of item number type used to define a replacement indicating whether it is MPN or 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

  Level of replacement whether it is specific to inventory organization or globally 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 is permanent or temporary.
• ReplacementTypeCode(required): string
  Maximum Length: 30

  Lookup value code of replacement type indicating whether it is 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: 15

  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.

{
    "required":[
        "PrimaryItemId",
        "PrimaryItemNumber",
        "ProcurementBUId",
        "ProcurementBUName",
        "ReplacementDefTypeCode",
        "ReplacementHeaderStatusCode",
        "ReplacementLevelTypeCode",
        "ReplacementTypeCode",
        "SupplierId",
        "SupplierName",
        "SupplierSite",
        "SupplierSiteId"
    ],
    "type":"object",
    "properties":{
        "ReplacementDefTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Look up value code of item number type used to define a replacement indicating whether it is MPN or internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ManufacturerPartNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the primary manufacturer part.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementStartDate":{
            "type":"string",
            "description":"Date on which replacement action gets initiated for a replacement definition.",
            "format":"date",
            "nullable":true
        },
        "ReplacementHeaderStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement header status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementHeaderStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the replacement header.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementEndDate":{
            "type":"string",
            "description":"Date on which reinstate action gets initiated for a replacement definition.",
            "format":"date",
            "nullable":true
        },
        "ReplacementDefType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of item number used to define a replacement indicating whether it is MPN or internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary supplier for which replacement is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier for which replacement is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary supplier site for which replacement is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SupplierId"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the replacement header has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":15,
            "type":"string",
            "description":"Name of the supplier site for which replacement is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcurementBUName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary internal item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "massReplacementLines":{
            "title":"Mass Replacement Lines",
            "type":"array",
            "description":"The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-item-post-request"
            }
        },
        "ReplacementType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of replacement indicating whether it is permanent or temporary.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementLevelType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Level of replacement whether it is specific to inventory organization or globally across organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManufacturerPartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ReplacementLevelTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the primary internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement type indicating whether it is permanent or temporary.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

• Array of: object massReplacementHeaders-massReplacementLines-item-post-request

{
    "title":"Mass Replacement Lines",
    "type":"array",
    "description":"The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-item-post-request"
    }
}

Nested Schema : massReplacementHeaders-massReplacementLines-item-post-request

Type: object

Show Source

• 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: 15

  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.
• 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.
• 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.
• 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 is 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.

{
    "required":[
        "AltSupplierId",
        "AltSupplierName",
        "AltSupplierSite",
        "AltSupplierSiteId",
        "DetailStatus",
        "DetailStatusCode",
        "Organization",
        "OrganizationId",
        "ReplacementId",
        "RequisitioningBUId",
        "RequisitioningBUName",
        "SourceDocumentLineNumber",
        "SourceDocumentNumber",
        "SubstituteType",
        "SubstituteTypeCode"
    ],
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Organization":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization in which replacement is initiated for a replacement header.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstituteTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations.",
            "nullable":false
        },
        "massReplacementPODetails":{
            "title":"Mass Replacement Purchase Order Details",
            "type":"array",
            "description":"The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-post-request"
            }
        },
        "ReplacementStartDate":{
            "type":"string",
            "description":"Date on which the replacement action gets initiated for a replacement organization or globally across organizations.",
            "format":"date",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in which replacement is initiated for a replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DetailStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementEndDate":{
            "type":"string",
            "description":"Date on which the reinstate action gets initiated for a replacement organization or globally across organizations.",
            "format":"date",
            "nullable":true
        },
        "DetailStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the replacement line has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "AltSupplierSite":{
            "title":"Site",
            "maxLength":15,
            "type":"string",
            "description":"Name of the alternate supplier site used as a replacement option.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstituteItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute internal item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationId",
                    "SubstituteMPNId"
                ]
            }
        },
        "SourceDocumentLineNumber":{
            "type":"number",
            "description":"Number that identifies the alternate source document line.",
            "nullable":false
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReplacementRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the mass replacement scheduled job submitted during replacement phase of the replacement lifecycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AltSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier used as a replacement option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubstituteType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Replacement method selected for a replacement organization or globally across organizations indicating whether it is an alternate supplier or alternate item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReinstateRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the mass replacement scheduled job submitted during the reinstate phase of the replacement life cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AltSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site used as a replacement option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AltSupplierId",
                    "RequisitioningBUId",
                    "SourceDocumentLineNumber",
                    "SourceDocumentNumber",
                    "SubstituteItemId",
                    "SubstituteMPNId",
                    "SubstituteTypeCode"
                ]
            }
        },
        "AltSupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the alternate supplier used as a replacement option.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstituteItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the substitute internal item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReinstateSrcDocumentLineNumber":{
            "type":"number",
            "description":"Number that identifies the primary source document line.",
            "nullable":true
        },
        "RequisitioningBUName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReinstateSrcDocumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the primary source document.",
            "nullable":true
        },
        "SourceDocumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the alternate source document.",
            "nullable":false
        },
        "SubstituteManufacturerPartNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the substitute manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReplacementDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ReinstateReplenishNotifyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute indicating that the replacement option is notified for reinstating the replenishment attributes.",
            "nullable":true
        },
        "SubstituteMPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReplacementReplenishNotifyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute indicating that the replacement option is notified for updating the replenishment attributes.",
            "nullable":true
        }
    }
}

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

• Array of: object massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-post-request

{
    "title":"Mass Replacement Purchase Order Details",
    "type":"array",
    "description":"The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-post-request"
    }
}

Nested Schema : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InlineReplacementFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute that indicates whether inline replacement is performed on the purchase order line.",
            "nullable":false,
            "default":false
        },
        "PODetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order detail for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ReplacementDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "POStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Attribute that indicates the status of the mass replacement for a purchase order detail record.",
            "nullable":false
        },
        "ReplacementAction":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether mass update is done against a purchase order detail record for a replacement action or a reinstate action.",
            "nullable":false
        },
        "PODistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QuantityDue":{
            "type":"number",
            "description":"Indicates the order quantity for the replacement line to be created on the purchase order.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : massReplacementHeaders-item-response

Type: object

Show Source

• 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.
• 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.
• 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.
• PrimaryItemNumber: string
  Maximum Length: 300

  Number that identifies the primary internal 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.
• ReplacementDefType: string
  Title: Meaning

  Maximum Length: 80

  Type of item number used to define a replacement indicating whether it is MPN or internal item.
• ReplacementDefTypeCode: string
  Maximum Length: 30

  Look up value code of item number type used to define a replacement indicating whether it is MPN or 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: 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

  Level of replacement whether it is specific to inventory organization or globally 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 is permanent or temporary.
• ReplacementTypeCode: string
  Maximum Length: 30

  Lookup value code of replacement type indicating whether it is permanent or temporary.
• 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.
• SupplierSite: string
  Title: Site

  Maximum Length: 15

  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.

{
    "type":"object",
    "properties":{
        "ReplacementDefTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Look up value code of item number type used to define a replacement indicating whether it is MPN or internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementStartDate":{
            "type":"string",
            "description":"Date on which replacement action gets initiated for a replacement definition.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReplacementHeaderStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement header status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementHeaderStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the replacement header.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MarkCompleteFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Attribute used to indicate the completion of replacement header for a permanent replacement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplacementEndDate":{
            "type":"string",
            "description":"Date on which reinstate action gets initiated for a replacement definition.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the primary internal item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary supplier site for which replacement is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SupplierId"
                ]
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the replacement header has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary internal item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplacementType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of replacement indicating whether it is permanent or temporary.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementLevelType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Level of replacement whether it is specific to inventory organization or globally across organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReplacementLevelTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the primary internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup value code of replacement type indicating whether it is permanent or temporary.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinesCount":{
            "type":"integer",
            "description":"Count of replacement detail records for a replacement header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the primary manufacturer part.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExceptionCount":{
            "type":"integer",
            "description":"Count of errors occurred during mass replacement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReplacementDefType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of item number used to define a replacement indicating whether it is MPN or internal item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary supplier for which replacement is defined.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplacementNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:DOC_SEQ_CATEGORY_CODE":"\"ORA_SCH_PR_SEQ_CAT_AUTO\"",
                "precision":18,
                "fnd:DOC_SEQUENCE":"true",
                "fnd:DOC_SEQ_APPLICATION_ID":"return new Long(10576);",
                "fnd:DOC_SEQ_TXN_DATE":"return object.getCurrentDBTime();",
                "fnd:DOC_SEQ_METHOD_CODE":"\"A\" "
            },
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier for which replacement is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":15,
            "type":"string",
            "description":"Name of the supplier site for which replacement is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcurementBUName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MakePermanentFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Attribute that indicates whether a temporary replacement is made permanent during its life cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "massReplacementLines":{
            "title":"Mass Replacement Lines",
            "type":"array",
            "description":"The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-item-response"
            }
        },
        "ManufacturerPartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object massReplacementHeaders-massReplacementLines-item-response

{
    "title":"Mass Replacement Lines",
    "type":"array",
    "description":"The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : massReplacementHeaders-massReplacementLines-item-response

Type: object

Show Source

• 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: 15

  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.
• 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.
• 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.
• 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.
• 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.
• 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.
• 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 is 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.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Organization":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization in which replacement is initiated for a replacement header.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubstituteTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the lookup type code for the replacement method selected for a replacement organization or globally across organizations.",
            "nullable":false,
            "x-queryable":true
        },
        "massReplacementPODetails":{
            "title":"Mass Replacement Purchase Order Details",
            "type":"array",
            "description":"The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response"
            }
        },
        "SubstituteItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the substitute internal item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplacementStartDate":{
            "type":"string",
            "description":"Date on which the replacement action gets initiated for a replacement organization or globally across organizations.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization in which replacement is initiated for a replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DetailStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementEndDate":{
            "type":"string",
            "description":"Date on which the reinstate action gets initiated for a replacement organization or globally across organizations.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DetailStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the replacement line has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AltSupplierSite":{
            "title":"Site",
            "maxLength":15,
            "type":"string",
            "description":"Name of the alternate supplier site used as a replacement option.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization in which replacement is initiated for a replacement header.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the substitute internal item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationId",
                    "SubstituteMPNId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentLineNumber":{
            "type":"number",
            "description":"Number that identifies the alternate source document line.",
            "nullable":false,
            "x-queryable":true
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplacementRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the mass replacement scheduled job submitted during replacement phase of the replacement lifecycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AltSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier used as a replacement option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubstituteType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Replacement method selected for a replacement organization or globally across organizations indicating whether it is an alternate supplier or alternate item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReinstateRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the mass replacement scheduled job submitted during the reinstate phase of the replacement life cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AltSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate supplier site used as a replacement option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "AltSupplierId",
                    "RequisitioningBUId",
                    "SourceDocumentLineNumber",
                    "SourceDocumentNumber",
                    "SubstituteItemId",
                    "SubstituteMPNId",
                    "SubstituteTypeCode"
                ]
            },
            "x-queryable":true
        },
        "AltSupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the alternate supplier used as a replacement option.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubstituteItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the substitute internal item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReinstateSrcDocumentLineNumber":{
            "type":"number",
            "description":"Number that identifies the primary source document line.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitioningBUName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReinstateSrcDocumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the primary source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the alternate source document.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstituteManufacturerPartNumber":{
            "title":"Trading Partner Item",
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the substitute manufacturer part number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReinstateReplenishNotifyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute indicating that the replacement option is notified for reinstating the replenishment attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "SubstituteMPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplacementReplenishNotifyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute indicating that the replacement option is notified for updating the replenishment attributes.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response

{
    "title":"Mass Replacement Purchase Order Details",
    "type":"array",
    "description":"The Mass Replacement PO Details resource creates the details of a purchase order that has undergone mass replacement.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response"
    }
}

Nested Schema : massReplacementHeaders-massReplacementLines-massReplacementPODetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InlineReplacementFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Attribute that indicates whether inline replacement is performed on the purchase order line.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PODetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order detail for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReplacementDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Attribute that indicates the status of the mass replacement for a purchase order detail record.",
            "nullable":false,
            "x-queryable":true
        },
        "ReplacementAction":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether mass update is done against a purchase order detail record for a replacement action or a reinstate action.",
            "nullable":false,
            "x-queryable":true
        },
        "PODistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution for which replacement is done.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityDue":{
            "type":"number",
            "description":"Indicates the order quantity for the replacement line to be created on the purchase order.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

massReplacementLines

Operation: /fscmRestApi/resources/11.13.18.05/massReplacementHeaders/{ReplacementId}/child/massReplacementLines

Parameters:

• ReplacementId: $request.path.ReplacementId

The massReplacementLines resource creates the replacement lines representing the organizations in which replacement is initiated for a replacement header.

Back to Top

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"
                }
            ]
        }
    ]
}"

Back to Top