Jump to

• Request
• Response
• Examples

Get all replacement headers

get

/fscmRestApi/resources/11.13.18.05/massReplacementHeaders

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Find replacement header according to the primary key.
    Finder Variables
    • ReplacementId; integer; Value that uniquely identifies the replacement header entity.
  • findByDetailInvStatus Finds replacement headers based on the inventory status of the replacement detail task.
    Finder Variables
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DisruptionReason; string; 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; 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; 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; 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.
  • LinesCount; integer; Count of replacement detail records for a replacement header.
  • ManufacturerPartId; integer; Value that uniquely identifies the primary manufacturer part number.
  • ManufacturerPartNumber; string; Number that identifies the primary manufacturer part.
  • ObjectVersionNumber; integer; Number of times the replacement header has been updated.
  • PrimaryItemDescription; string; Description of the primary internal item.
  • PrimaryItemId; integer; Value that uniquely identifies the primary internal item.
  • PrimaryItemImageURL; string; URL of the primary item image uploaded in item master.
  • PrimaryItemNumber; string; Number that identifies the primary internal item.
  • PrimaryUnitOfMeasure; string; Attribute indicating the name of the primary unit of measure for the original item.
  • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
  • ProcurementBUName; string; Name of the procurement business unit.
  • PurchasingUnitOfMeasure; string; Attribute indicating the name of the purchasing unit of measure for the original item.
  • ReinstateFlag; boolean; Attribute that indicates whether reinstatement is completed for the replacement task for at least one organization.
  • ReplacementDefType; string; Type of item number used to define a replacement indicating whether it's an MPN or an internal item.
  • ReplacementDefTypeCode; string; Lookup code of item number type used to define a replacement indicating whether it's an MPN or an internal item.
  • ReplacementEndDate; string; Date on which reinstate action gets initiated for a replacement definition.
  • ReplacementFlag; boolean; Attribute that indicates whether the replacement phase is completed for the replacement task for at least one organization.
  • ReplacementHeaderStatus; string; Status of the replacement header.
  • ReplacementHeaderStatusCode; string; Lookup value code of replacement header status.
  • ReplacementId; integer; Value that uniquely identifies the replacement header.
  • ReplacementLevelType; string; Indicates whether the level of replacement is specific to an inventory organization or applicable across organizations.
  • ReplacementLevelTypeCode; string; Lookup value code of replacement level indicating whether the replacement is specific to inventory organization or globally across organizations.
  • ReplacementNumber; integer; Number that uniquely identifies the replacement header.
  • ReplacementStartDate; string; Date on which replacement action gets initiated for a replacement definition.
  • ReplacementType; string; Type of replacement indicating whether it's permanent or temporary.
  • ReplacementTypeCode; string; Lookup code of the replacement type indicating whether it's permanent or temporary.
  • SubItemNotAssignedFlag; boolean; Attribute indicating that the substitute item isn't assigned to one or more organizations for a global replacement task.
  • SupplierId; integer; Value that uniquely identifies the primary supplier for which replacement is defined.
  • SupplierName; string; Name of the supplier for which replacement is defined.
  • SupplierPartNumber; string; Attribute indicating the supplier item number for the original item.
  • SupplierSite; string; Name of the supplier site for which replacement is defined.
  • SupplierSiteId; integer; Value that uniquely identifies the primary supplier site for which replacement is defined.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : massReplacementHeaders

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"PRC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object massReplacementHeaders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-item-response"
    }
}

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 : massReplacementHeaders-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ReplacementDefTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Lookup code of item number type used to define a replacement indicating whether it's an MPN or an 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":false
        },
        "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
        },
        "EnableReinstateFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "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"
            }
        },
        "SupplierPartNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Attribute indicating the supplier item number for the original item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary internal item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryItemImageURL":{
            "title":"Primary Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the primary item image uploaded in item master.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplacementType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of replacement indicating whether it's permanent or temporary.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplacementLevelType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates whether the level of replacement is specific to an inventory organization or applicable across organizations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisruptionReason":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Attribute that stores the user-defined lookup meaning that represents the reason for supply disruption. This attribute is captured while creating the replacement task.",
            "nullable":false,
            "readOnly":true,
            "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 code of the replacement type indicating whether it's 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
        },
        "EstimatedEndDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":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
        },
        "ReinstateFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Attribute that indicates whether reinstatement is completed for the replacement task for at least one organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionCount":{
            "type":"integer",
            "description":"Count of errors occurred during mass replacement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReinstateGlobalFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether to allow a reinstatement on the replacement detail task by validating its inventory status for each organization in a global replacement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubItemNotAssignedFlag":{
            "type":"boolean",
            "description":"Attribute indicating that the substitute item isn't assigned to one or more organizations for a global replacement task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Attribute indicating the name of the primary unit of measure for the original item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ReplacementDefType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of item number used to define a replacement indicating whether it's an MPN or an 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
        },
        "massReplacementGroupedOrgs":{
            "title":"Mass Replacement Grouped Organizations",
            "type":"array",
            "description":"The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.",
            "items":{
                "$ref":"#/components/schemas/massReplacementHeaders-massReplacementGroupedOrgs-item-response"
            }
        },
        "ReplacementFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Attribute that indicates whether the replacement phase is completed for the replacement task for at least one organization.",
            "nullable":true,
            "readOnly":true,
            "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":"240",
            "type":"string",
            "description":"Name of the supplier site for which replacement is defined.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchasingUnitOfMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Attribute indicating the name of the purchasing unit of measure for the original item.",
            "nullable":true,
            "readOnly":true,
            "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":false
        },
        "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"
            }
        },
        "PackagingString":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the packaging string of the original item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerPartId":{
            "type":"integer",
            "description":"Value that uniquely identifies the primary manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisruptionReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Attribute that stores the user-defined lookup code that represents the reason for supply disruption. This attribute is captured while creating the replacement task.",
            "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 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

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

{
    "title":"Mass Replacement Grouped Organizations",
    "type":"array",
    "description":"The massReplacementGroupedOrgs resource gets the organizations that are grouped during the item replacement process.",
    "items":{
        "$ref":"#/components/schemas/massReplacementHeaders-massReplacementGroupedOrgs-item-response"
    }
}

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-massReplacementGroupedOrgs-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organizations in a group for which item replacement is performed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Unique identifier for the requisitioning business units that correspond to the organizations in a group for which item replacement is performed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReplacementOrgId":{
            "type":"integer",
            "description":"Unique identifier for the grouped organizations in the item replacement task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the organizations in a group for which item replacement is performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitioningBUName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Names of the requisitioning business units that correspond to the organizations in a group for which item replacement is performed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the organizations in a group for which item replacement is performed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReplacementId":{
            "type":"integer",
            "description":"Unique identifier of the replacement task in which organizations are grouped to perform item replacement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.",
            "format":"int64",
            "nullable":false,
            "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 : massReplacementHeaders-massReplacementLines-item-response

Type: object

Show Source

• 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.
• ItemSubInvExistsFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the item subinventory association exists for the disrupted item.
• ItemTransactionDefExistsFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether the item transaction default exists for the disrupted item.
• 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.

{
    "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
        },
        "DetailInvStatus":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the status name of the replacement lifecycle for inventory entities at the inventory organization level.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "NewItemSubFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Attribute that indicates whether a new item subinventory is added to the replacement item during the item replacement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DetailInvStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the status code of the replacement lifecycle for inventory entities at the inventory organization level.",
            "nullable":true,
            "x-queryable":true
        },
        "InvExceptionFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether there is an exception for the replacement detail during mass replacement on inventory entities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NewItemLocFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Attribute that indicates whether a new item locator is added to the replacement item during the item replacement process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CopyFromDisruptedTransactionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Attribute that indicates whether the item transaction defaults must be copied from the disrupted item or not.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierPartNumber":{
            "title":"Supplier Item",
            "maxLength":"300",
            "type":"string",
            "description":"Attribute indicating the supplier item number for the replacement item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "RequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request for the mass replacement scheduled process during item replacement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "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
        },
        "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
        },
        "StuckInProgressFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchasingUnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Attribute indicating the name of the purchasing unit of measure for the replacement item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "PackagingString":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the packaging string of the replacement item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubstituteMPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternate manufacturer part number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CopyFromDisruptedItemFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Attribute that indicates whether the inventory entities must be copied from the original item or not.",
            "nullable":true,
            "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
        },
        "AlternateItemImageURL":{
            "title":"Primary Image URL",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the alternate item image uploaded in item master.",
            "nullable":true,
            "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
        },
        "ItemSubInvExistsFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the item subinventory association exists for the disrupted item.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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":"240",
            "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
        },
        "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
        },
        "SubstituteType":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Replacement method selected for a replacement organization or globally across organizations indicating whether it's an alternate supplier or alternate item.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReplenishByInvSourceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Attribute that indicates whether item subinventories with inventory as the replenishment source must be replaced or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ReinstateSrcDocumentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the primary source document.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryUnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Attribute indicating the name of the primary unit of measure for the replacement item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SourceDocumentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the alternate source document.",
            "nullable":false,
            "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
        },
        "ItemTransactionDefExistsFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the item transaction default exists for the disrupted item.",
            "nullable":true,
            "readOnly":true,
            "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

insertIntoGroupedOrgs

Operation: /fscmRestApi/resources/11.13.18.05/massReplacementHeaders/action/insertIntoGroupedOrgs

Description of the action to insert grouped organizations for a replacement task.

raiseNotifyPlannerEvent

Operation: /fscmRestApi/resources/11.13.18.05/massReplacementHeaders/action/raiseNotifyPlannerEvent

Description of the action to raise a business event to send notifications to the planners and par counters by providing the replacement details.

Back to Top

Examples

This example describes how to get all replacement headers.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementHeaders"

Example Response Body

The following shows an example 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”,
            "SupplierId": 6134,
            "SupplierSite": “SCH 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_PERMANENT",
            "ReplacementType": "Permanent",
            "PrimaryItemNumber": "SCH2020",
            "PrimaryItemDescription": "Z-Med 12 Pacemaker",
            "PrimaryItemId": 300100545303414,
            "ManufacturerPartNumber": null,
            "ManufacturerPartId": null,
            "SupplierName": “Supplier01”,
            "SupplierId": 6134,
            "SupplierSite": “SCH 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"
                }
            ]
        },
        {
            "ReplacementId": 300100553117155,
            "ReplacementNumber": 1003,
            "ReplacementLevelTypeCode": "ORA_SCH_PR_ORG",
            "ReplacementLevelType": "Each organization individually",
            "ReplacementDefTypeCode": "ORA_SCH_PR_INTERNAL_ITEM",
            "ReplacementDefType": "Master item",
            "ReplacementTypeCode": "ORA_SCH_PR_PERMANENT",
            "ReplacementType": "Permanent",
            "PrimaryItemNumber": "SCH2060",
            "PrimaryItemDescription": "Scorpio NRG Knee System Tibial Insert",
            "PrimaryItemId": 300100545303628,
            "ManufacturerPartNumber": null,
            "ManufacturerPartId": null,
            "SupplierName": “SCH Supplier01”,
            "SupplierId": 6134,
            "SupplierSite": “SCH 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": "false",
            "MarkCompleteFlag": "false",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155",
                    "name": "massReplacementHeaders",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155",
                    "name": "massReplacementHeaders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/massReplacementHeaders/300100553117155/child/massReplacementLines",
                    "name": "massReplacementLines",
                    "kind": "collection"
                }
        "

Back to Top